Maven 2.x Taglist Plugin

Report Java Annotations tag (mainly @SuppressWarning)

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 2.4
  • Fix Version/s: None
  • Labels:
    None
  • Environment:
    All
  • Number of attachments :
    4

Description

The annotation @SuppressWarnings is not a comment, but it's an interesting tag to report.
With extrapolation, if I implement a @TODO annotation, it could be considered as a tag.

=> Annotations is interesting to report ?

For exemple, the annotation's attribute could be displayed as comment (others tags principle).

Code exemple : 

/**
 * MyMethod 
 */
@SuppressWarnings({"unchecked", "deprecated"})
public void toto(){
    // ...
}
Tag Class Occurrences Tag strings used by tag class
Annotation 1 SuppressWarnings

And in detail :

Occurrences found in code : x

org.package.class line
unchecked 42
deprecated 42

I began to check the code, but I prefer discuss of (philosofical) orientation before submit a (big) patch.

Poeple agree ? remarks ?

Thanks.

  1. Text File
    patch-trunk-20110302.txt
    30/Oct/12 8:01 AM
    46 kB
    Alix Lourme
  2. Text File
    patch-trunk-20110302.txt
    18/Apr/11 9:29 AM
    46 kB
    Alix Lourme
  3. Text File
    patch-trunk-20110302.txt
    04/Mar/11 7:48 AM
    45 kB
    Alix Lourme
  4. Text File
    patch-trunk-20110302.txt
    02/Mar/11 12:17 PM
    45 kB
    Alix Lourme

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Alix Lourme added a comment -

Patch from trunk in date of : 2 march 2011, 7h15 PM.

Content :

  • Source code
  • Unit Test
  • Site documentation (light)
Show
Alix Lourme added a comment - Patch from trunk in date of : 2 march 2011, 7h15 PM. Content : Source code Unit Test Site documentation (light)
Hide
Permalink
Robert Scholte added a comment -

I think QDox is a much stronger solution to resolve annotations instead of trying to match strings.

Show
Robert Scholte added a comment - I think QDox is a much stronger solution to resolve annotations instead of trying to match strings.
Hide
Permalink
Alix Lourme added a comment -

Hello Robert,

Thanks for the suggestion.

But in the current algorithm , all lines of each file are already scanned.
So annotation determination is just à "indexOf" on a lower case string added to the others checks.

Using QDox implies another scan of each file (if annotation must be check) => more work.

I agree the result should be best ... but the objective is just an extraction of attribut.

I will do some test with QDox ... for science .

Show
Alix Lourme added a comment - Hello Robert, Thanks for the suggestion. But in the current algorithm , all lines of each file are already scanned. So annotation determination is just à "indexOf" on a lower case string added to the others checks. Using QDox implies another scan of each file (if annotation must be check) => more work. I agree the result should be best ... but the objective is just an extraction of attribut. I will do some test with QDox ... for science .
Hide
Permalink
Alix Lourme added a comment -

Update patch with multi-line annotation.

Show
Alix Lourme added a comment - Update patch with multi-line annotation.
Hide
Permalink
Alix Lourme added a comment -

For information, patch used on many projects in company and there is no problem.

Show
Alix Lourme added a comment - For information, patch used on many projects in company and there is no problem.
Hide
Permalink
Alix Lourme added a comment -

Quick fix to correct :

java.lang.StringIndexOutOfBoundsException: String index out of range: X
	at java.lang.String.substring(String.java:1934)
	at org.codehaus.mojo.taglist.FileAnalyser.extractAnnotationAttribute(FileAnalyser.java:409)
	at org.codehaus.mojo.taglist.FileAnalyser.scanFile(FileAnalyser.java:240)
	at org.codehaus.mojo.taglist.FileAnalyser.execute(FileAnalyser.java:146)
	at org.codehaus.mojo.taglist.TagListReport.executeReport(TagListReport.java:326)

When annotation written like that :

@SuppressWarnings("unchecked" 
    )
@Override
Show
Alix Lourme added a comment - Quick fix to correct : java.lang.StringIndexOutOfBoundsException: String index out of range: X at java.lang. String .substring( String .java:1934) at org.codehaus.mojo.taglist.FileAnalyser.extractAnnotationAttribute(FileAnalyser.java:409) at org.codehaus.mojo.taglist.FileAnalyser.scanFile(FileAnalyser.java:240) at org.codehaus.mojo.taglist.FileAnalyser.execute(FileAnalyser.java:146) at org.codehaus.mojo.taglist.TagListReport.executeReport(TagListReport.java:326) When annotation written like that : @SuppressWarnings( "unchecked" ) @Override

People

  • Assignee:
    Unassigned
    Reporter:
    Alix Lourme
Vote (3)
Watch (3)

Dates

  • Created:
    Updated: