yihua opened a new pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes URL: https://github.com/apache/incubator-hudi/pull/1195 ## What is the purpose of the pull request This PR adds a new maven profile to generate unified Javadoc for all Java and Scala classes. Given that most modules have Java classes only, and only two modules, `hudi-spark` and `hudi-cli`, have Scala source code (only a few files), it is better to put the apidocs of all classes in one place. Since most classes are in Java, the Javadoc is chosen to generate the apidocs, with [genjavadoc-plugin](https://github.com/lightbend/genjavadoc) to translate Scaladoc comments into Java source so that the `javadoc` tool can recognize it. ## Brief change log - Add a new maven profile `unijavadoc` to generate unified Javadoc at the project root. By running `mvn clean javadoc:aggregate -Punijavadoc`, the apidocs pages are generated under `target/site/apidocs`. - Fix one issue in `IncrementalRelation.scala` that caused the following error while generating the Javadoc: ``` [ERROR] /Users/yihua/tech/repo/incubator-hudi/hudi-spark/target/genjavadoc/org/apache/hudi/IncrementalRelation.java:[17,58] type argument scala.runtime.Nothing$ is not within bounds of type-variable T ``` ## Verify this pull request This PR only adds new maven profile and can be verified by running: `mvn clean javadoc:aggregate -Punijavadoc` ## Committer checklist - [ ] Has a corresponding JIRA in PR title & commit - [ ] Commit message is descriptive of the change - [ ] CI is green - [ ] Necessary doc changes done or have another open PR - [ ] For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
