Skip to content

Commit 8657060

Browse files
authored
fix: Fix javadoc publishing (#63)
Motivation I noticed that javadoc was not included in the maven releases. Modifications Update version and configuration of maven-javadoc-plugin, including selective inclusion of classes from dependencies exposed in the public APIs (ByteString, ListenableFuture, StreamObserver) Result Javadoc will be published with the next release of etcd-java
1 parent 7f91bad commit 8657060

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

pom.xml

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,13 @@
102102
<scope>compile</scope>
103103
</dependency>
104104

105+
<dependency>
106+
<groupId>com.google.protobuf</groupId>
107+
<artifactId>protobuf-java</artifactId>
108+
<version>${protobuf-version}</version>
109+
<scope>compile</scope>
110+
</dependency>
111+
105112
<!-- used only for etcd cluster configuration files -->
106113
<dependency>
107114
<groupId>com.google.code.gson</groupId>
@@ -197,15 +204,27 @@
197204
<plugin>
198205
<groupId>org.apache.maven.plugins</groupId>
199206
<artifactId>maven-javadoc-plugin</artifactId>
200-
<version>3.2.0</version>
207+
<version>3.3.1</version>
201208
<configuration>
202209
<source>8</source>
203-
<quiet>true</quiet>
204-
<nonavbar>true</nonavbar>
205-
<notree>true</notree>
206-
<nocomment>true</nocomment>
207-
<nohelp>true</nohelp>
210+
<breakiterator>true</breakiterator>
208211
<doclint>none</doclint>
212+
<includeDependencySources>true</includeDependencySources>
213+
<dependencySourceIncludes>
214+
<!-- classes from these show up in the API (unfortunately!) -->
215+
<dependencySourceInclude>com.google.guava:guava</dependencySourceInclude>
216+
<dependencySourceInclude>com.google.protobuf:protobuf-java</dependencySourceInclude>
217+
<dependencySourceInclude>io.grpc:grpc-stub</dependencySourceInclude>
218+
</dependencySourceIncludes>
219+
<sourceFileIncludes>
220+
<sourceFileInclude>src/main/java/com/ibm/etcd/client/**/*.java</sourceFileInclude>
221+
<sourceFileInclude>target/generated-sources/protobuf/**/*.java</sourceFileInclude>
222+
<!-- pick out only those external classes/interfaces that are used in the API -->
223+
<sourceFileInclude>target/distro-javadoc-sources/protobuf-java-*/com/google/protobuf/ByteString.java</sourceFileInclude>
224+
<sourceFileInclude>target/distro-javadoc-sources/guava-*/com/google/common/util/concurrent/ListenableFuture.java</sourceFileInclude>
225+
<sourceFileInclude>target/distro-javadoc-sources/grpc-stub-*/io/grpc/stub/StreamObserver.java</sourceFileInclude>
226+
</sourceFileIncludes>
227+
<sourcepath>${basedir}</sourcepath>
209228
</configuration>
210229
<executions>
211230
<execution>

0 commit comments

Comments
 (0)