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

misleading Exit code: 2 - javadoc: error - No source files for package

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 3.1.1
    • 3.3.0
    • javadoc
    • None

    Description

      Configuration is done as follows:

      // code 
      
            <!-- javadoc plugin -->
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <version>3.1.1</version>
              <configuration>	  <!--phase>generate-sources</phase--> <!-- this is the default -->
      	  <sourcepath>src/main/java:src/test/java</sourcepath>
      	  <tags>
      	    <tag>
      	      <name>todo</name>
      	      <placement>a</placement>
      	      <head>what is to be done in the present code fragment;
      	      jopas only</head>
      	    </tag>
      	    <tag>
      	      <name>To.Do</name>
      	      <placement>a</placement>
      	      <head>ToDo: </head>
      	    </tag>
      	  </tags>
      
      ...
      
       </plugin>
      

      The outcoming when doing mvn javadoc:test-javadoc is as follows:
      ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:test-javadoc (default-cli) on project l2r: An error has occurred in Test Javadoc report generation:
      [ERROR] Exit code: 2 - javadoc: error - No source files for package jopas
      [ERROR]
      [ERROR] Command line was: /usr/lib64/jvm/java/bin/javadoc @options @argfile
      [ERROR]
      [ERROR] Refer to the generated Javadoc files in '/home/ernst/Software/target/site/testapidocs' dir.

      Note that the package is not org.jopas, but just jopas.
      In the tag definition, there is a line break just before jopas.
      If I remove that line break, all works fine.

      I think this gives indication to very gragilepom reading.. either this plugin or maven.

      Attachments

        Activity

          People

            rfscholte Robert Scholte
            ErnstReissner Ernst Reissner
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: