[ checkstyle-Bugs-2882261 ] Custom javadoc tags in type javadoc stop checkstyle

View: New views
1 Messages — Rating Filter:   Alert me  

[ checkstyle-Bugs-2882261 ] Custom javadoc tags in type javadoc stop checkstyle

by SourceForge.net :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Bugs item #2882261, was opened at 2009-10-20 12:13
Message generated for change (Tracker Item Submitted) made by swisswheel
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=2882261&group_id=29721

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Core Framework
Group: release 5.0
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Martin Zeltner (swisswheel)
Assigned to: Oliver Burn (oburn)
Summary: Custom javadoc tags in type javadoc stop checkstyle

Initial Comment:
I refer here to the closed but not fixed issue 2791544, due this issue has been closed by an unfriendly robot...
+++++++++++++
I use a taglets library for a variety of additional tags. Whenever
checkstyle encounters one of these in the type javadocs (but not in the
method javadocs apparently), it outputs an exception and stops checking
that class.

The message is:
Got an exception - java.lang.IllegalArgumentException: the name [warning]
is not a valid Javadoc tag name

I fixed it by catching and ignoring the IllegalArgumentException in
JavadocTypeCheck.java line 221.

A better method might be for checkstyle to provide a way for users to list
their doclet or taglet libraries, so that these can be skipped.



Test.java
----------------
/**
* @mytag Hello
*/
public class Test {

}

--------------
checkstyle config
--------------
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<property name="severity" value="warning"/>
<module name="TreeWalker">
<module name="JavadocType"/>
</module>
</module>

Could you please solve that issue and for example provide a version 5.0.1?

Cheers
Martin

----------------------------------------------------------------------

You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=2882261&group_id=29721

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Checkstyle-devel mailing list
Checkstyle-devel@...
https://lists.sourceforge.net/lists/listinfo/checkstyle-devel