Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-631

Exclusion of generated code creates reference not found error

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • 3.1.1
    • None
    • javadoc
    • None
    • Maven 3.5.3
      Jdk 8
      maven-javadoc-plugin 3.1.1

    Description

      Using exclusion files, I excluded some generated code:

      <sourceFileExcludes>
      	<sourceFileExclude>${javadoc.excludes}</sourceFileExclude>
      </sourceFileExcludes>
      

      with a property for example:

      <javadoc.excludes>**/generated/**</javadoc.excludes>

      But the thing is, we reference some generated code classes in javadoc, so of course we have these errors of not found reference:

      /var/lib/jenkins/jobs/[PathToJava].java:19: error: package ...mccommon.mcinterface.generated does not exist  
      
      15:03:08 /var/lib/jenkins/jobs/[PathToJava].java:33: error: cannot find symbol
      15:03:08 implements HistoricalRequestParameter<IFAMQPADMRequestHistoricData, IFAMQPRequestHistoricDataResponse> 
      15:03:08 symbol: class IFAMQPADMRequestHistoricData

      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

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            antoine.tran Antoine Tran
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: