Maven 1.x Javadoc Plugin
  1. Maven 1.x Javadoc Plugin
  2. MPJAVADOC-42

javadoc:generate from CVS fails in some projects

    Details

    • Type: Bug Bug
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: 1.7
    • Fix Version/s: None
    • Labels:
      None
    • Number of attachments :
      8

      Description

      I'm using javadoc-1.7 from CVS and the javadoc:warning tag fails in many of our projects. Here is an example:

      maven-javadoc-plugin:report:
      [javadoc] Generating Javadoc
      [javadoc] Javadoc execution
      [javadoc] Loading source files for package com.cpqd.util.fileconnector...
      [javadoc] Loading source files for package com.cpqd.util.fileconnector.conne
      ctor...
      [javadoc] Loading source files for package XXXX
      [javadoc] Constructing Javadoc information...
      [javadoc] Copying file C:\Documents and Settings\t_fl01\.maven\cache\maven-javadoc-plugin-1.7-SNAPSHOT\plugin-resources\stylesheet.css to file S:\components\components\fileconnector\target\docs\apidocs\stylesheet.css...
      [javadoc] Building tree for all the packages and classes...
      [javadoc] Building index for all the packages and classes...
      [javadoc] javadoc: warning - getUserName: @return tag has no arguments.
      [javadoc] Building index for all classes...
      [javadoc] Generating S:\components\components\fileconnector\target\docs\apidocs\help-doc.html...
      [javadoc] 1 warning

      BUILD FAILED
      File...... C:\Documents and Settings\t_fl01\.maven\cache\maven-javadoc-plugin-1.7-SNAPSHOT\plugin.jelly
      Element... javadoc:javadocwarnings
      Line...... 483
      Column.... 11
      String index out of range: -1
      Total time: 13 seconds
      Finished at: Wed Sep 01 17:42:13 BRT 2004

      I will see if I can narrow down the issue and realize what's going on.
      I guess the javadoc is generating some output in an unexpected format that crashes the parser (i.e, the JavadocWarningsTextToXml.java) - if that's the case, I think it would be safer to ignore such exceptions, at least while this new feature is not stable yet (as we might face some similar issues in the future as the users uses other JDKs or javadoclets to generate the output).

      1. javadocwarnings.diff
        20 kB
        Steven Caswell
      2. javadoc-warnings-13.jsl
        3 kB
        Steven Caswell
      3. report-13.txt
        2 kB
        Arnaud Heritier
      4. report-14.txt
        4 kB
        Arnaud Heritier
      5. report-15.txt
        3 kB
        Arnaud Heritier
      6. StandardDoclet13XmlBuilder.java
        2 kB
        Steven Caswell
      7. StandardDocletDefaultXmlBuilder.java
        5 kB
        Steven Caswell
      8. XmlBuilder.java
        1 kB
        Steven Caswell

        Issue Links

          Activity

          Hide
          Steven Caswell added a comment -

          src/main/org/apache/maven/javadoc/StandardDocletDefaultXmlBuilder.java:

          • Implemenation of XmlBuilder strategy to handle javadoc warnings from the 1.4/1.5 standard doclet
          Show
          Steven Caswell added a comment - src/main/org/apache/maven/javadoc/StandardDocletDefaultXmlBuilder.java: Implemenation of XmlBuilder strategy to handle javadoc warnings from the 1.4/1.5 standard doclet
          Hide
          Steven Caswell added a comment -

          src/plugin-resources/javadoc-warnings-13.jsl:

          • Created from javadoc-warnings.jsl to handle outputing of the 1.3 style warnings
          Show
          Steven Caswell added a comment - src/plugin-resources/javadoc-warnings-13.jsl: Created from javadoc-warnings.jsl to handle outputing of the 1.3 style warnings
          Hide
          Steven Caswell added a comment -

          The test case (src/test/org/apache/maven/javadoc/JavadocWarningsTextToXmlTest.java) requires the files report-13.txt, report-14.txt, and report-15.txt to reside in src/test

          The one thing I don't know how to do is to set up a test case to test plugin jelly under the different jdks.

          Show
          Steven Caswell added a comment - The test case (src/test/org/apache/maven/javadoc/JavadocWarningsTextToXmlTest.java) requires the files report-13.txt, report-14.txt, and report-15.txt to reside in src/test The one thing I don't know how to do is to set up a test case to test plugin jelly under the different jdks.
          Hide
          Felipe Leme added a comment -

          I'm unassigning it as I'm really out of spare time lately.

          Anyway, regarding the last post, I don't know the answer either. Maybe the best solution is to write a test case for JDK 1.3 and put a <j:if> call in the beginning of the test checking for the JDK version and skipping the test if the version is not 1.3

          Show
          Felipe Leme added a comment - I'm unassigning it as I'm really out of spare time lately. Anyway, regarding the last post, I don't know the answer either. Maybe the best solution is to write a test case for JDK 1.3 and put a <j:if> call in the beginning of the test checking for the JDK version and skipping the test if the version is not 1.3
          Hide
          Lukas Theussl added a comment -

          Closing as won't fix as maven 1.1 will require jdk >= 1.4.

          Show
          Lukas Theussl added a comment - Closing as won't fix as maven 1.1 will require jdk >= 1.4.

            People

            • Assignee:
              Unassigned
              Reporter:
              Felipe Leme
            • Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 3 hours
                3h
                Remaining:
                Time Spent - 40 minutes Remaining Estimate - 2 hours, 20 minutes
                2h 20m
                Logged:
                Time Spent - 40 minutes Remaining Estimate - 2 hours, 20 minutes
                40m