Javadoc cleanups, publishing.

Author: dweiss

TODO.txt

@@ -1,7 +1,6 @@
 
 Porting to gradle
 
-- apply forbidden APIs
 - packaging and sonatype/maven publishing
 - remove maven artifacts (pom.xml, update readmes).
 

build.gradle

@@ -9,7 +9,7 @@ plugins {
   id 'de.thetaphi.forbiddenapis' version '3.0.1' apply false
 }
 
-rootProject.version = '0.8.3-SNAPSHOT'
+rootProject.version = '0.9.0-SNAPSHOT'
 ext {
   fullName = "High Performance Primitive Collections"
   legal = files('LICENSE.txt')
@@ -22,11 +22,15 @@ apply from: file('gradle/validation/forbidden-apis.gradle')
 apply from: file('gradle/git/gitinfo.gradle')
 apply from: file('gradle/java/compiler.gradle')
 apply from: file('gradle/java/tests.gradle')
-
+apply from: file('gradle/java/javadoc.gradle')
 apply from: file('gradle/ide/idea.gradle')
+apply from: file('gradle/publishing/maven.gradle')
 
 allprojects {
   repositories {
     mavenCentral()
   }
+
+  version = rootProject.version
+  group   = "com.carrotsearch"
 }

gradle/java/javadoc.gradle

@@ -0,0 +1,14 @@
+
+allprojects {
+  plugins.withType(JavaPlugin) {
+    tasks.withType(Javadoc) {
+      options.encoding = 'UTF-8'
+      title = "${project.name} ${project.version} API Documentation"
+
+      options.addBooleanOption('html5', true)
+      options.addBooleanOption('Xdoclint:all,-missing', true)
+      options.noIndex()
+    }
+  }
+}
+

gradle/publishing/maven.gradle

@@ -0,0 +1,82 @@
+
+configure(rootProject) {
+  ext {
+    published = [
+        ":hppc",
+    ]
+  }
+
+  configure(subprojects.findAll { it.path in rootProject.published }) {
+    apply plugin: 'maven-publish'
+    apply plugin: 'signing'
+
+    tasks.withType(GenerateModuleMetadata) {
+      enabled = false
+    }
+
+    plugins.withType(JavaPlugin) {
+      publishing {
+        repositories {
+          maven {
+            name = 'sonatype'
+            url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
+
+            credentials {
+              if (project.hasProperty('nexusUsername')) {
+                username project.nexusUsername
+              }
+              if (project.hasProperty('nexusPassword')) {
+                password project.nexusPassword
+              }
+            }
+          }
+        }
+      }
+
+      task sourcesJar(type: Jar, dependsOn: classes) {
+        archiveClassifier = 'sources'
+        from sourceSets.main.allJava
+      }
+
+      task javadocJar(type: Jar, dependsOn: javadoc) {
+        archiveClassifier = 'javadoc'
+        from javadoc.destinationDir
+      }
+
+      publishing {
+        def configurePom = {
+          name = "High Performance Primitive Collections"
+          url = "https://github.com/carrotsearch/hppc"
+          description = "High Performance Primitive Collections: " +
+              "data structures (maps, sets, lists, stacks, queues) generated " +
+              "for combinations of object and primitive types to conserve JVM " +
+              "memory and speed up execution."
+
+          licenses {
+            license {
+              name = 'Apache 2'
+              url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+            }
+          }
+        }
+
+        publications {
+          signed(MavenPublication) {
+            from components.java
+            groupId = project.group
+            artifactId = project.archivesBaseName
+
+            artifact sourcesJar
+            artifact javadocJar
+
+            pom(configurePom)
+          }
+        }
+      }
+
+      signing {
+        sign publishing.publications.signed
+      }
+    }
+  }
+}

hppc/src/main/java/com/carrotsearch/hppc/HashOrderMixingStrategy.java

@@ -21,7 +21,7 @@ public interface HashOrderMixingStrategy extends Cloneable {
    * A new key mixer value. The value can be derived from the new buffer size of the
    * container, but preferably should be random and unique. 
    * 
-   * @param newContainerBufferSize
+   * @param newContainerBufferSize New size of the calling container's buffer.
    */
   public int newKeyMixer(int newContainerBufferSize);
 

hppc/src/main/templates/com/carrotsearch/hppc/KTypeScatterSet.java

@@ -9,8 +9,8 @@
  * strategy and uses a simpler (faster) bit distribution function.
  * 
  * <p>
- * <strong>Note:</strong> read about <a href="{@docRoot}
- * /overview-summary.html#scattervshash">important differences between hash and
+ * <strong>Note:</strong> read about
+ * <a href="{@docRoot}/overview-summary.html#scattervshash">important differences between hash and
  * scatter sets</a>.
  * </p>
  * 

hppc/src/main/templates/com/carrotsearch/hppc/KTypeVTypeMap.java

@@ -95,7 +95,7 @@ public interface KTypeVTypeMap<KType, VType> extends KTypeVTypeAssociativeContai
 
   /**
    * Compares the specified object with this set for equality. Returns
-   * <tt>true</tt> if and only if the specified object is also a
+   * {@code true} if and only if the specified object is also a
    * {@link KTypeVTypeMap} and both objects contains exactly the same key-value
    * pairs.
    */

settings.gradle

@@ -1,5 +1,5 @@
 
-rootProject.name = 'hppc'
+rootProject.name = 'hppc-root'
 
 include 'hppc-template-intrinsics'
 include 'hppc-template-processor'