Maven Javadoc Plugin
  1. Maven Javadoc Plugin
  2. MJAVADOC-194

javadoc 2.4 does not [build-helper:add-source {execution: add-source}] when aggregating a javadoc for a project

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.4
    • Fix Version/s: 2.5
    • Labels:
      None
    • Environment:
      Maven version: 2.0.9
      Java version: 1.5.0_12
      OS name: "windows xp" version: "5.1" arch: "x86" Family: "windows"

      Description

      The javadoc does not include the "additional source" files defined using the "build-helper:add-source" in each of my subproject pom files when using javadoc plugin 2.4. The javadoc plugin 2.3 worked correctly.

      I use the "build-helper:add-source" to include additional source directories to the build. The additional source directories contain my generated source file. When I run the command using javadoc plugin version 2.4:
      mvn javadoc:javadoc -Daggregate=true
      (or have the aggregate=true specified inside of the pom) the "build-helper:add-source" is not run for each of the subprojects before the aggregated javadoc is created. Therefore the javadoc does not include the documentation for the files in the additional source directories.

      I also noted that the output for 2.3 javadoc plugin is:
      [INFO] task-segment: [javadoc:javadoc] (aggregator-style)
      but the output for the 2.4 javadoc plugin is:
      [INFO] task-segment: [javadoc:javadoc]

      I am not sure if the above output is changed between versions or if the "aggregator-style" is not detectd in the 2.4 version and has an influence in this issue.

      I have attached the log file for running my project using javadoc plugin version 2.3 and 2.4. Version 2.3 works and version 2.4 does not include the additional source files in the aggregated javadoc.

      1. JavaDocTestCase.zip
        48 kB
        Lois Modesitt
      2. m209out-UsingJavadoc2.3.txt
        1.05 MB
        Lois Modesitt
      3. m209out-UsingJavadoc2.4.txt
        1.31 MB
        Lois Modesitt
      4. m209out-UsingJavadoc2.5SNAPSHOT.txt
        450 kB
        Lois Modesitt

        Issue Links

          Activity

          Hide
          Benjamin Bentmann added a comment -

          This sound like a duplicate of MJAVADOC-168 which has just been fixed and a new snapshot deployed. Could you verify?

          Show
          Benjamin Bentmann added a comment - This sound like a duplicate of MJAVADOC-168 which has just been fixed and a new snapshot deployed. Could you verify?
          Hide
          Lois Modesitt added a comment - - edited

          aggregated javadoc created BEFORE "build-helper:add-source" run on each module involved in the aggregated javadoc. Therefore the source files included with the "build-helper:add-source" is not included in the aggregated javadoc. Using the command:

          mvn javadoc:javadoc -Daggregate=true

          I used the 2.5-SNAPSHOT version of the maven-javadoc-plugin and this did not fix the problem.

          The attached log files show the order of execution of the "javadoc" and the "build-helper:add-source" for each module included in the project is different between 2.3 (works) and 2.4/2.5-SNAPSHOT (does not work).

          Show
          Lois Modesitt added a comment - - edited aggregated javadoc created BEFORE "build-helper:add-source" run on each module involved in the aggregated javadoc. Therefore the source files included with the "build-helper:add-source" is not included in the aggregated javadoc. Using the command: mvn javadoc:javadoc -Daggregate=true I used the 2.5-SNAPSHOT version of the maven-javadoc-plugin and this did not fix the problem. The attached log files show the order of execution of the "javadoc" and the "build-helper:add-source" for each module included in the project is different between 2.3 (works) and 2.4/2.5-SNAPSHOT (does not work).
          Hide
          Siveton Vincent added a comment -

          Sorry, but I am not sure to understand correctly your usecase: could you send us a test case?

          Show
          Siveton Vincent added a comment - Sorry, but I am not sure to understand correctly your usecase: could you send us a test case?
          Hide
          Lois Modesitt added a comment - - edited

          UseCase:
          Create aggregated javadocs for both source code in the default location and
          source code in an additional location. I include the "additional source code directory"
          using the "build-helper-maven-plugin" which is included in the parent pom:
          JavaDocTestCase/pom.xml.

          Problem:
          When I run the command:
          mvn javadoc:javadoc -Daggregate=true
          using javadoc version 2.4, the classes in the "additional" source code directory
          is not included in the aggregated javadocs.
          *******Using javadoc version 2.3, works correctly by including the additional
          source code directory.**********

          See the attached file JavaDocTestCase.zip.
          Please read the file "Readme.txt" for more information about this test.
          Let me know if you have any more questions.

          Show
          Lois Modesitt added a comment - - edited UseCase: Create aggregated javadocs for both source code in the default location and source code in an additional location. I include the "additional source code directory" using the "build-helper-maven-plugin" which is included in the parent pom: JavaDocTestCase/pom.xml. Problem: When I run the command: mvn javadoc:javadoc -Daggregate=true using javadoc version 2.4, the classes in the "additional" source code directory is not included in the aggregated javadocs. *******Using javadoc version 2.3, works correctly by including the additional source code directory.********** See the attached file JavaDocTestCase.zip. Please read the file "Readme.txt" for more information about this test. Let me know if you have any more questions.
          Hide
          Siveton Vincent added a comment -

          It is mainly due to the remove of @aggregator tag

          Show
          Siveton Vincent added a comment - It is mainly due to the remove of @aggregator tag
          Hide
          Siveton Vincent added a comment -

          Having a mojo with @aggregator should resolve this issue

          Show
          Siveton Vincent added a comment - Having a mojo with @aggregator should resolve this issue
          Hide
          Lois Modesitt added a comment -

          Will this change be done to the 2.5-SNAPSHOT? If it is, will someone let me know so that I can try out the 2.5-SNAPSHOT with this fix?

          Show
          Lois Modesitt added a comment - Will this change be done to the 2.5-SNAPSHOT? If it is, will someone let me know so that I can try out the 2.5-SNAPSHOT with this fix?
          Hide
          Siveton Vincent added a comment -

          I just fixed MJAVADOC-196 so you will be able to try the 2.5-snap

          Show
          Siveton Vincent added a comment - I just fixed MJAVADOC-196 so you will be able to try the 2.5-snap
          Hide
          Lois Modesitt added a comment -

          I used the javadoc plugin 2.5-SNAPSHOT version: 20080606.132616-15 and the problem is still there. Is your change in this version of the SNAPSHOT?

          Show
          Lois Modesitt added a comment - I used the javadoc plugin 2.5-SNAPSHOT version: 20080606.132616-15 and the problem is still there. Is your change in this version of the SNAPSHOT?
          Hide
          Siveton Vincent added a comment -

          yes but you need to call javadoc:aggregate instead of javadoc:javadoc. See svn log file http://svn.apache.org/viewvc?rev=663917&view=rev
          You could also generate the documentation from the trunk.

          Show
          Siveton Vincent added a comment - yes but you need to call javadoc:aggregate instead of javadoc:javadoc. See svn log file http://svn.apache.org/viewvc?rev=663917&view=rev You could also generate the documentation from the trunk.
          Hide
          Lois Modesitt added a comment -

          Yes, that fix is great. I tried the test using javadoc:aggregate and the problem is resolved. Thanks

          Show
          Lois Modesitt added a comment - Yes, that fix is great. I tried the test using javadoc:aggregate and the problem is resolved. Thanks
          Hide
          Lois Modesitt added a comment -

          Do you (Vincent) close this issue? Or am I supposed to do this?

          Show
          Lois Modesitt added a comment - Do you (Vincent) close this issue? Or am I supposed to do this?
          Hide
          Siveton Vincent added a comment -

          fixed due to MJAVADOC-196

          Show
          Siveton Vincent added a comment - fixed due to MJAVADOC-196

            People

            • Assignee:
              Siveton Vincent
              Reporter:
              Lois Modesitt
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development