Share

checkstyle

Tracker: Bugs

5 Custom javadoc tags in type javadoc stop checkstyle - ID: 2882261
Last Update: Tracker Item Submitted ( swisswheel )

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


Martin Zeltner ( swisswheel ) - 2009-10-20 10:13

5

Open

None

Oliver Burn

Core Framework

release 5.0

Public


Comments

No follow-up comments have been posted.

Attached File

No Files Currently Attached

Change

No changes have been made to this artifact.