Skip to content

[to #348] add javadoc in maven site reporting #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zz-jason merged 4 commits into from
Feb 11, 2022
Merged

[to #348] add javadoc in maven site reporting #507

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc5d67a
add javadoc in maven site reporting
iosmanthus Feb 10, 2022
1330b15
recover missing comments
iosmanthus Feb 10, 2022
d44b875
remove invalid config
iosmanthus Feb 10, 2022
ebc7b8a
Merge branch 'master' into mvn-site-patch
ti-srebot Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 5 additions & 21 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@
<proto.folder>${basedir}/proto</proto.folder>
<gpg.keyname>fake gpg key name</gpg.keyname>
<gpg.skip>true</gpg.skip>
<javadoc.skip>true</javadoc.skip>
</properties>

<dependencies>
Expand Down Expand Up @@ -256,6 +255,11 @@

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.3.1</version>
</plugin>
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
Expand Down Expand Up @@ -445,26 +449,6 @@
</filesets>
</configuration>
</plugin>
<!-- Javadoc Plug-in -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<configuration>
<skip>${javadoc.skip}</skip>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration> <!-- add this to disable checking -->
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</execution>
</executions>
</plugin>
Comment on lines -448 to -467
Copy link
Member

@peng1999 peng1999 Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After deleting this, does mvn javadoc:javadoc still works? Users may want to solely generate apidocs themselves.

Copy link
Member Author

@iosmanthus iosmanthus Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't work again, needs to run mvn compile site instead.

Copy link
Member

@zz-jason zz-jason Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you add a github action to automatically compile the site for each release?

<!--- Needs to shade Protobuf 3 since other projects might use other version -->
Copy link
Member

@peng1999 peng1999 Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidentally deleted?

Copy link
Member Author

@iosmanthus iosmanthus Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, recovered.

<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down