Skip to content
Permalink
Browse files
Instructions for javadoc command
  • Loading branch information
davecromberge committed Jun 30, 2021
1 parent 8f47110 commit e6632b30ca5117877a89a94934ed9948a7bc23cf
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 30 deletions.
@@ -17,8 +17,8 @@
under the License.
-->

[![Build Status](https://travis-ci.org/apache/datasketches-memory.svg?branch=master)](https://travis-ci.org/apache/datasketches-memory)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-memory/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-memory)
[![Build Status](https://travis-ci.org/apache/datasketches-memory.svg?branch=master)](https://travis-ci.org/apache/datasketches-memory)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-memory/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-memory)
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/datasketches-memory.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/datasketches-memory/context:java)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/apache/datasketches-memory.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/datasketches-memory/alerts/)
[![Coverage Status](https://coveralls.io/repos/github/apache/datasketches-memory/badge.svg?branch=master)](https://coveralls.io/github/apache/datasketches-memory?branch=master)
@@ -32,7 +32,7 @@
runtime dependencies and can be used in any application that needs to manage data structures outside
the Java heap.

Please visit the main [DataSketches website](https://datasketches.apache.org) for more information.
Please visit the main [DataSketches website](https://datasketches.apache.org) for more information.

If you are interested in making contributions to this site please see our [Community](https://datasketches.apache.org/docs/Community/) page for how to contact us.

@@ -83,7 +83,7 @@ This DataSketches component is pure Java and requires the following JDKs to comp
### Recommended Build Tool
This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool.

There are two types of tests: normal unit tests and tests run by the strict profile.
There are two types of tests: normal unit tests and tests run by the strict profile.

To run normal unit tests:

@@ -93,6 +93,12 @@ To run the strict profile tests:

$ mvn clean test -P strict

To run javadoc on this multi-module project, use:

$ mvn clean package javadoc:javadoc -DskipTests=true

* There are sometimes problems resolving module deps, e.g. see https://issues.apache.org/jira/browse/MJAVADOC-437

To install jars built from the downloaded source:

$ mvn clean install -DskipTests=true
@@ -32,7 +32,6 @@
<name>${project.artifactId}</name>

<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
<java.version>11</java.version>
<jdk-toolchain.version>11</jdk-toolchain.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
@@ -29,6 +29,7 @@
</parent>

<dependencies>
<!-- Test Scope -->
<dependency>
<groupId>org.apache.datasketches</groupId>
<artifactId>datasketches-memory-java8</artifactId>
@@ -39,6 +40,21 @@
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>${testng.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for UTF8 testing -->
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>${protobuf-java.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for xxHash testing -->
<groupId>net.openhft</groupId>
<artifactId>zero-allocation-hashing</artifactId>
<version>${zero-allocation-hashing.version}</version>
<scope>test</scope>
</dependency>
</dependencies>

@@ -36,6 +36,8 @@
<jdk-toolchain.version>8</jdk-toolchain.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<!-- override javadoc for this module only -->
<maven.javadoc.skip>false</maven.javadoc.skip>
</properties>

<profiles>
@@ -67,6 +69,30 @@
<forceJavacCompilerUse>true</forceJavacCompilerUse>
</configuration>
</plugin>
<!-- Javadoc aggregate in a multi-module project can be unreliable on first builds, see:
https://issues.apache.org/jira/browse/MJAVADOC-437 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<jdkToolchain>
<version>${jdk-toolchain.version}</version>
</jdkToolchain>
</configuration>
<executions>
<execution>
<id>javadoc-aggregate</id>
<phase>package</phase>
<goals>
<goal>javadoc-no-fork</goal>
</goals>
<configuration>
<includeDependencySources>true</includeDependencySources>
<includeTransitiveDependencySources>true</includeTransitiveDependencySources>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
</build>
@@ -38,14 +38,14 @@
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>${testng.version}</version>
<scope>compile</scope>
</dependency>
</dependencies>

<artifactId>datasketches-memory-java9-tests</artifactId>
<name>${project.artifactId}</name>

<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
<java.version>9</java.version>
<jdk-toolchain.version>9</jdk-toolchain.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
@@ -40,7 +40,6 @@
<name>${project.artifactId}</name>

<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
<java.version>9</java.version>
<jdk-toolchain.version>9</jdk-toolchain.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
@@ -43,15 +43,31 @@
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>${testng.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for UTF8 testing -->
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>${protobuf-java.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for xxHash testing -->
<groupId>net.openhft</groupId>
<artifactId>zero-allocation-hashing</artifactId>
<version>${zero-allocation-hashing.version}</version>
<scope>test</scope>
</dependency>
</dependencies>

<artifactId>datasketches-memory-tests</artifactId>
<name>${project.artifactId}</name>

<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>

<!-- The tests in the following profiles run against the assembled MR-JAR. Hence, they
only run during the Maven package phase. Different profiles are selected based on
the environment-specific version of Java that was used to run `mvn package`. This
@@ -108,6 +108,10 @@
<!-- org.jacoco Maven Plugins -->
<jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
<maven-help-plugin.version>3.2.0</maven-help-plugin.version>
<!-- deploy artifacts to nexus from this module only -->
<maven.deploy.skip>false</maven.deploy.skip>
<maven.install.skip>false</maven.install.skip>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>

<dependencies>
48 pom.xml
@@ -124,7 +124,7 @@ under the License.
<maven-deploy-plugin.version>3.0.0-M1</maven-deploy-plugin.version> <!-- overrides parent -->
<maven-enforcer-plugin.version>3.0.0-M3</maven-enforcer-plugin.version> <!-- overrides parent -->
<maven-jar-plugin.version>3.2.0</maven-jar-plugin.version> <!-- overrides parent -->
<maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version> <!-- overrides parent -->
<maven-javadoc-plugin.version>3.3.0</maven-javadoc-plugin.version> <!-- overrides parent -->
<maven-release-plugin.version>3.0.0-M1</maven-release-plugin.version> <!-- overrides parent -->
<maven-remote-resources-plugin.version>[1.7.0,)</maven-remote-resources-plugin.version> <!-- overrides parent -->
<maven-source-plugin.version>3.2.1</maven-source-plugin.version> <!-- overrides parent -->
@@ -140,6 +140,9 @@ under the License.
<coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
<!-- other -->
<lifecycle-mapping.version>1.0.0</lifecycle-mapping.version>
<maven.deploy.skip>true</maven.deploy.skip>
<maven.install.skip>true</maven.install.skip>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>

<repositories>
@@ -167,24 +170,30 @@ under the License.
</repository>
</repositories>

<dependencies>
<!-- Test Scope -->
<dependency>
<!-- Used for UTF8 testing -->
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>${protobuf-java.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for xxHash testing -->
<groupId>net.openhft</groupId>
<artifactId>zero-allocation-hashing</artifactId>
<version>${zero-allocation-hashing.version}</version>
<scope>test</scope>
</dependency>
<!-- END: UNIQUE FOR THIS JAVA COMPONENT -->
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>${testng.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for UTF8 testing -->
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>${protobuf-java.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<!-- Used for xxHash testing -->
<groupId>net.openhft</groupId>
<artifactId>zero-allocation-hashing</artifactId>
<version>${zero-allocation-hashing.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</dependencyManagement>

<build>
<pluginManagement>
@@ -249,6 +258,7 @@ under the License.
<executions>
<execution>
<id>attach-javadocs</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>

0 comments on commit e6632b3

Please sign in to comment.