You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Lenny Primak (Jira)" <ji...@apache.org> on 2023/03/23 04:09:00 UTC
[jira] [Commented] (MJAVADOC-631) Exclusion of generated code creates reference not found error
[ https://issues.apache.org/jira/browse/MJAVADOC-631?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17703858#comment-17703858 ]
Lenny Primak commented on MJAVADOC-631:
---------------------------------------
Same here
> 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
> 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)