[
https://issues.apache.org/jira/browse/DRILL-6389?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16491351#comment-16491351
]
ASF GitHub Bot commented on DRILL-6389:
---------------------------------------
ilooner commented on a change in pull request #1276: DRILL-6389: Generate
Javadoc for all classes and fix some warnings.
URL: https://github.com/apache/drill/pull/1276#discussion_r191024447
##########
File path: pom.xml
##########
@@ -202,6 +208,138 @@
<build>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>${basedir}</sourcepath>
+ <sourceFileExcludes>
+ <!-- Don't include codegen -->
+ <exclude>**/src/main/codegen/**/*.java</exclude>
+ <!-- Don't include target -->
+ <exclude>**/target/**/*.java</exclude>
+ <!--
+ Note: There is a bug with javadoc that causes javadoc to be
unable to find the org.apache.parquet.hadoop.CodecFactory class in the
parquet-hadoop dependency. This
+ is because we have declared our own org.apache.parquet.hadoop
package in exec/java-exec. As a result we have to exclude some parquet classes,
which generate
+ javadoc warnings because of this.
+ -->
+ <!-- Exclude files with strange package linking issues -->
Review comment:
@arina-ielchiieva I agree this is not ideal. I spent some more time trying
to resolve the warnings introduced by these files and couldn't find a solution.
I've removed the excludes so now we will still generate javadoc for these
files. The only negative consequence to this is that there will be a few more
javadoc warnings when running `mvn javadoc:aggregate`.
Would you be okay with removing the excludes and resolving the extra javadoc
warnings in a separate Jira?
----------------------------------------------------------------
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
> Fix For: 1.14.0
>
>
> 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)
