Issue Details (XML | Word | Printable)

Key: MPJAVADOC-35
Type: New Feature New Feature
Status: Closed Closed
Resolution: Fixed
Priority: Minor Minor
Assignee: Unassigned
Reporter: Steven Caswell
Votes: 1
Watchers: 2
Operations

If you were logged in you would be able to see more operations.
Maven 1.x Javadoc Plugin

Add javadoc warning report formatted similar to Checkstyle report

Created: 25/Jul/04 11:03 AM   Updated: 12/Dec/05 07:01 PM   Resolved: 12/Dec/05 07:01 PM
Component/s: None
Affects Version/s: None
Fix Version/s: 1.7

Time Tracking:
Not Specified

File Attachments: 1. File javadoc-warnings.jsl (6 kB)
2. Text File javadoc-warnings.patch (5 kB)
3. Java Source File Javadoc1.java (5 kB)
4. Java Source File Javadoc2.java (0.2 kB)
5. Java Source File JavadocWarningsTextToXml.java (10 kB)
6. Java Source File JavadocWarningsTextToXml.java (9 kB)
7. Java Source File JavadocWarningsTextToXmlTest.java (4 kB)
8. Text File report.txt (5 kB)

Image Attachments:

1. javadoc-warning-sample.jpg
(181 kB)
Issue Links:
dependent
 


 Description  « Hide

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.



Steven Caswell added a comment - 25/Jul/04 11:12 AM

This shows a sample Javadoc warning report


Steven Caswell added a comment - 25/Jul/04 11:14 AM

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


Steven Caswell added a comment - 25/Jul/04 11:15 AM

src/plugin-resources/javadoc-warnings.jsl


Steven Caswell added a comment - 25/Jul/04 11:17 AM

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


Steven Caswell added a comment - 25/Jul/04 11:17 AM

src/test/report.txt


Steven Caswell added a comment - 25/Jul/04 11:19 AM

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


Steven Caswell added a comment - 25/Jul/04 11:20 AM

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


Steven Caswell added a comment - 25/Jul/04 11:44 AM

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


Steven Caswell added a comment - 25/Jul/04 11:54 AM

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


Arnaud Heritier added a comment - 25/Jul/04 12:23 PM

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


Arnaud Heritier added a comment - 25/Jul/04 12:24 PM

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


dion gillard added a comment - 25/Jul/04 10:11 PM

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


Arnaud Heritier added a comment - 21/Aug/04 02:47 PM

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


Arnaud Heritier added a comment - 21/Aug/04 04:23 PM

Added. Thanks a lot.


Felipe Leme added a comment - 01/Sep/04 11:58 PM

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


Arnaud Heritier added a comment - 03/Sep/04 06:27 PM

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


Matthias Kerkhoff added a comment - 14/Sep/04 08:04 AM

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.


Jeff Jensen added a comment - 22/Aug/05 10:53 AM

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


Arnaud Heritier added a comment - 22/Aug/05 11:22 AM

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


Jeff Jensen added a comment - 22/Aug/05 12:03 PM

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.


Lukas Theussl added a comment - 12/Dec/05 07:01 PM

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).