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

Add javadoc warning report formatted similar to Checkstyle report

    Details

    • Type: New Feature New Feature
    • Status: Closed Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.7
    • Labels:
      None
    • Number of attachments :
      9

      Description

      As discussed on the dev list (http://nagoya.apache.org/eyebrowse/ReadMsg?listId=148&msgNo=21309) I have written an extension to the javadoc plugin that creates a report of the javadoc warning. The report is formatted in a style similar to that of the Checkstyle report. There is a new class that converts the text of the report.txt output to xml, a new jsl that formats the report, and changes to plugin.jelly, plugin.properties, and project.xml. There is a test class that exercises the new converter class. I don't know how to test the jsl, but will try to do so if someone can give some guidance.

      1. Javadoc1.java
        5 kB
        Steven Caswell
      2. Javadoc2.java
        0.2 kB
        Steven Caswell
      3. javadoc-warnings.jsl
        6 kB
        Steven Caswell
      4. javadoc-warnings.patch
        5 kB
        Steven Caswell
      5. JavadocWarningsTextToXml.java
        10 kB
        Steven Caswell
      6. JavadocWarningsTextToXml.java
        9 kB
        Steven Caswell
      7. JavadocWarningsTextToXmlTest.java
        4 kB
        Steven Caswell
      8. report.txt
        5 kB
        Steven Caswell
      1. javadoc-warning-sample.jpg
        181 kB

        Issue Links

          Activity

          Hide
          Matthias Kerkhoff added a comment -

          I also ran into the corrupted source paths described above. In our project, it happens in a subproject that generates the source code with jaxb. The paths displayed in the report and the links point to non-existant directories - the first four characters are missing in our case. During generation of the report, a jelly exception is thrown.

          Show
          Matthias Kerkhoff added a comment - I also ran into the corrupted source paths described above. In our project, it happens in a subproject that generates the source code with jaxb. The paths displayed in the report and the links point to non-existant directories - the first four characters are missing in our case. During generation of the report, a jelly exception is thrown.
          Hide
          Jeff Jensen added a comment -

          Wow, this would be a fantastic improvement for this plugin.

          Show
          Jeff Jensen added a comment - Wow, this would be a fantastic improvement for this plugin.
          Hide
          Arnaud Heritier added a comment -

          It's already in the plugin but there's some bugs. You can try it if you want.

          Show
          Arnaud Heritier added a comment - It's already in the plugin but there's some bugs. You can try it if you want.
          Hide
          Jeff Jensen added a comment -

          Apologies for wasting the bits..
          In looking for a possible existing report on "java.lang.StringIndexOutOfBoundsException: String index out of range" (a problem I have been experiencing for awhile) with javadoc-plugin, and also wishing for the "Javadoc Report" to have this format, I messed up thinking this enhancement was for Javadoc Report, not Javadoc Warnings Report (which already exsists, of course!).
          Sorry again.

          Show
          Jeff Jensen added a comment - Apologies for wasting the bits.. In looking for a possible existing report on "java.lang.StringIndexOutOfBoundsException: String index out of range" (a problem I have been experiencing for awhile) with javadoc-plugin, and also wishing for the "Javadoc Report" to have this format, I messed up thinking this enhancement was for Javadoc Report, not Javadoc Warnings Report (which already exsists, of course!). Sorry again.
          Hide
          Lukas Theussl added a comment -

          Closing as it has been implemented and seems to be working now. Please open a separate issue if there are still problems (but note that jdk >1.4 is required now for maven 1.1).

          Show
          Lukas Theussl added a comment - Closing as it has been implemented and seems to be working now. Please open a separate issue if there are still problems (but note that jdk >1.4 is required now for maven 1.1).

            People

            • Assignee:
              Unassigned
              Reporter:
              Steven Caswell
            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: