Javadoc Audit warnings

CodePro AnalytiX (Audit & Test), includes over 1000 audit rules and metrics, JUnit test generation & editing, code coverage, and duplicate code analysis

Moderators: gnebling, jwren, Eric Clayberg, Dan Rubel, Brian Wilkerson, dcarew

Javadoc Audit warnings

Postby cclarke » Mon Sep 21, 2009 3:49 am

I have methods that contain a "(non-Javadoc)...@see" generated by Eclipse. For method signatures that contain parameters that are arrays or are generics the audit rule "Missing Javadoc comment for method..." is triggered.

Allow non-javadoc comments with only a single @see tag is checked.
In Preferences > CodePro > Javadoc > Methods, all boxes are checked.

Is there a way, short of disabling the rule, to fix the violation?

Eclipse 3.5, CodePro 6.2
Posts: 4
Joined: Wed Jun 04, 2008 7:53 am

Re: Javadoc Audit warnings

Postby Brian Wilkerson » Mon Sep 21, 2009 10:28 am

I wasn't able to duplicate the behavior for methods with an array parameter, but I was able to duplicate it for a method with a parameter of a generic type (List<String>, in case you're interested). It looks like a bug to me.

Until we get this fixed, I believe that if you also select the check box labeled "Ignore methods that override inherited methods" that CodePro should stop reporting these violations.
Brian Wilkerson
Google, Inc.
Brian Wilkerson
Posts: 32
Joined: Fri Apr 28, 2006 9:37 am

Return to CodePro AnalytiX & PlusPak. EclipsePro Audit & Test

Who is online

Users browsing this forum: No registered users and 1 guest