[
https://issues.apache.org/jira/browse/DRILL-6389?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16481264#comment-16481264
]
ASF GitHub Bot commented on DRILL-6389:
---------------------------------------
ilooner opened a new pull request #1276: DRILL-6389: Generate Javadoc for all
class and fix some warnings.
URL: https://github.com/apache/drill/pull/1276
# Fixes For Javadoc Generation
This patch accomplishes the following:
- Javadoc is generated for all classes (except for a few excluded classes).
- Javadoc warnings about unknown classes and packages are fixed.
- Some (but not all) easy javadoc warnings are fixed.
- Documentation was added on how to add and view javadocs
## Implementation Details
The javadoc plugin can only compile and link all the javadocs if `mvn
javadoc:aggregate` is called in the project root directory. The javadoc plugin
is also unaware of the test dependencies, so they must be explicitly added to
the plugin in order for javadoc to be able to resolve test classes.
Also since test dependencies must be explicitly added to the javadoc plugin,
we must also create test jars for drill-common and drill-java-exec which
contain common test classes used by other modules, and add these test-jars to
the javadoc plugin dependency list.
Some classes were excluded from javadoc generation due to weird package
linking issues I could not figure out resulting in javadoc warnings.
There was also a bug with the maven-license-plugin. The plugin definition
was included in the plugins section not the pluginManagement section of the
pom. This caused a strange issue where an extra license header was being added
in storage-kudu/src/main/codegen/templates/KuduRecordWriter.java . This caused
the javadoc tool to throw an error.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Fix building javadocs
> ---------------------
>
> Key: DRILL-6389
> URL: https://issues.apache.org/jira/browse/DRILL-6389
> Project: Apache Drill
> Issue Type: Improvement
> Reporter: Timothy Farkas
> Assignee: Timothy Farkas
> Priority: Major
>
> Javadocs don't build when running
> {code}
> mvn javadoc:aggregate
> {code}
> Get the javadocs for all the classes to build. Fix some warnings.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
