Maven 1.x Javadoc Plugin

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. Java Source File
    Javadoc1.java
    25/Jul/04 11:19 AM
    5 kB
    Steven Caswell
  2. Java Source File
    Javadoc2.java
    25/Jul/04 11:20 AM
    0.2 kB
    Steven Caswell
  3. File
    javadoc-warnings.jsl
    25/Jul/04 11:15 AM
    6 kB
    Steven Caswell
  4. Text File
    javadoc-warnings.patch
    25/Jul/04 11:54 AM
    5 kB
    Steven Caswell
  5. Java Source File
    JavadocWarningsTextToXml.java
    25/Jul/04 11:44 AM
    10 kB
    Steven Caswell
  6. Java Source File
    JavadocWarningsTextToXml.java
    25/Jul/04 11:14 AM
    9 kB
    Steven Caswell
  7. Java Source File
    JavadocWarningsTextToXmlTest.java
    25/Jul/04 11:17 AM
    4 kB
    Steven Caswell
  8. Text File
    report.txt
    25/Jul/04 11:17 AM
    5 kB
    Steven Caswell
  1. javadoc-warning-sample.jpg
    181 kB
    25/Jul/04 11:12 AM

Issue Links

depends upon

Bug - A problem which impairs or prevents the functions of the product. MPJAVADOC-42 javadoc:generate from CVS fails in some projects

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Steven Caswell added a comment -

This shows a sample Javadoc warning report

Show
Steven Caswell added a comment - This shows a sample Javadoc warning report
Hide
Permalink
Steven Caswell added a comment -

src/main/org/apache/maven/javadoc/JavadocWarningsTextToXml.java

Show
Steven Caswell added a comment - src/main/org/apache/maven/javadoc/JavadocWarningsTextToXml.java
Hide
Permalink
Steven Caswell added a comment -

src/plugin-resources/javadoc-warnings.jsl

Show
Steven Caswell added a comment - src/plugin-resources/javadoc-warnings.jsl
Hide
Permalink
Steven Caswell added a comment -

src/test/org/apache/maven/javadoc/JavadocWarningsTextToXmlTest.java

Show
Steven Caswell added a comment - src/test/org/apache/maven/javadoc/JavadocWarningsTextToXmlTest.java
Hide
Permalink
Steven Caswell added a comment -

src/test/report.txt

Show
Steven Caswell added a comment - src/test/report.txt
Hide
Permalink
Steven Caswell added a comment -

1 of 2 files used to generate the report.txt used in the JavadocWarningsTextToXmlTest.java test case

Show
Steven Caswell added a comment - 1 of 2 files used to generate the report.txt used in the JavadocWarningsTextToXmlTest.java test case
Hide
Permalink
Steven Caswell added a comment -

2 of 2 files used to generate the report.txt used in the JavadocWarningsTextToXmlTest.java test case

Show
Steven Caswell added a comment - 2 of 2 files used to generate the report.txt used in the JavadocWarningsTextToXmlTest.java test case
Hide
Permalink
Steven Caswell added a comment -

Oops, I realized that the first version of this file I submitted had the wrong copyright/license notice and wasn't indented properly.

Show
Steven Caswell added a comment - Oops, I realized that the first version of this file I submitted had the wrong copyright/license notice and wasn't indented properly.
Hide
Permalink
Steven Caswell added a comment -

Patch to plugin.jelly, plugin.properties, project.xml

Show
Steven Caswell added a comment - Patch to plugin.jelly, plugin.properties, project.xml
Hide
Permalink
Arnaud Heritier added a comment -

Steven,
This new feature is for the javadoc plugin.
I moved the issue.

Show
Arnaud Heritier added a comment - Steven, This new feature is for the javadoc plugin. I moved the issue.
Hide
Permalink
Arnaud Heritier added a comment -

Thanks for your work.
We'll try to apply it as soon as possible.

Show
Arnaud Heritier added a comment - Thanks for your work. We'll try to apply it as soon as possible.
Hide
Permalink
dion gillard added a comment -

It would be good to have the javadoc test project updated too

Show
dion gillard added a comment - It would be good to have the javadoc test project updated too
Hide
Permalink
Arnaud Heritier added a comment -

Committed to CVS.
I need to add a project to test it.

Show
Arnaud Heritier added a comment - Committed to CVS. I need to add a project to test it.
Hide
Permalink
Arnaud Heritier added a comment -

Added. Thanks a lot.

Show
Arnaud Heritier added a comment - Added. Thanks a lot.
Hide
Permalink
Felipe Leme added a comment -

Steven,

The JavadocWarningsTextToXml.buildMap() method is throwing a exception when building the javadoc with JDK 1.3.

So, could you please take a look on MPJAVADOC-42?

Thanks,

Felipe

Show
Felipe Leme added a comment - Steven, The JavadocWarningsTextToXml.buildMap() method is throwing a exception when building the javadoc with JDK 1.3. So, could you please take a look on MPJAVADOC-42 ? Thanks, Felipe
Hide
Permalink
Arnaud Heritier added a comment -

There's a bug if sources are copied in $

{internal_javadoc_src_tmp}

Files path are corrupted in the report.
$

{pom.build.sourceDirectory}

is used in javadoc-warnings.jsl

Show
Arnaud Heritier added a comment - There's a bug if sources are copied in $ {internal_javadoc_src_tmp} Files path are corrupted in the report. $ {pom.build.sourceDirectory} is used in javadoc-warnings.jsl
Hide
Permalink
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
Permalink
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
Permalink
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
Permalink
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
Permalink
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
Vote (1)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: