[to #348] add javadoc in maven site reporting #507
Conversation
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
| <!-- 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> |
There was a problem hiding this comment.
After deleting this, does mvn javadoc:javadoc still works? Users may want to solely generate apidocs themselves.
There was a problem hiding this comment.
Doesn't work again, needs to run mvn compile site instead.
There was a problem hiding this comment.
could you add a github action to automatically compile the site for each release?
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <!--- Needs to shade Protobuf 3 since other projects might use other version --> |
pom.xml
Outdated
| <configuration> | ||
| <skip>${javadoc.skip}</skip> | ||
| </configuration> |
There was a problem hiding this comment.
Currently javadoc.skip defaults to true. Why do we want to skip the javadoc generation in mvn site and set this as default behavior?
There was a problem hiding this comment.
Removed this configuration.
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
|
LGTM |
|
@peng1999, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. You are not a reviewer or committer or co-leader or leader. |
|
/merge |
|
/run-all-tests |
Signed-off-by: iosmanthus myosmanthustree@gmail.com
What problem does this PR solve?
Issue Number: close #348
What is changed and how does it work?
This pull request move javadoc generating into maven site reporting section
