[
https://issues.apache.org/jira/browse/MJAVADOC-631?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17958017#comment-17958017
]
Olivier Lamy commented on MJAVADOC-631:
---------------------------------------
This project has moved from Jira to GitHub Issues. This issue was migrated to
[apache/maven-javadoc-plugin#924|https://github.com/apache/maven-javadoc-plugin/issues/924].
Please visit the GitHub issue to view further activity, add comments, or
subscribe to receive notifications.
> Exclusion of generated code creates reference not found error
> -------------------------------------------------------------
>
> Key: MJAVADOC-631
> URL: https://issues.apache.org/jira/browse/MJAVADOC-631
> Project: Maven Javadoc Plugin (Moved to GitHub Issues)
> Issue Type: Improvement
> Components: javadoc
> Affects Versions: 3.1.1
> Environment: Maven 3.5.3
> Jdk 8
> maven-javadoc-plugin 3.1.1
> Reporter: Antoine Tran
> Priority: Major
>
> Using exclusion files, I excluded some generated code:
> {code:java}
> <sourceFileExcludes>
> <sourceFileExclude>${javadoc.excludes}</sourceFileExclude>
> </sourceFileExcludes>
> {code}
> with a property for example:
> {code:java}
> <javadoc.excludes>**/generated/**</javadoc.excludes>{code}
> But the thing is, we reference some generated code classes in javadoc, so of
> course we have these errors of not found reference:
> {code:java}
> /var/lib/jenkins/jobs/[PathToJava].java:19: error: package
> ...mccommon.mcinterface.generated does not exist
> {code}
> {code:java}
> 15:03:08 /var/lib/jenkins/jobs/[PathToJava].java:33: error: cannot find
> symbol{code}
> {code:java}
> 15:03:08 implements HistoricalRequestParameter<IFAMQPADMRequestHistoricData,
> IFAMQPRequestHistoricDataResponse>
> 15:03:08 symbol: class IFAMQPADMRequestHistoricData{code}
> So either we don't exclude referenced classes, but we have multiple error
> from a generated code (in this case Avro generated code), or we exclude them,
> but in that case, we cannot reference them in the eye of maven-javadoc-plugin.
>
> There should be a way to either:
> * exclude some code and ignore reference to these classes
> * or mark some generated code as special, so that we generated javadoc for
> them too, but we silently ignore any warnings/errors related to them
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
