CODEWITHSUNDEEP
javamavencheckstyle
yegor256
yegor256

Reputation: 105043

How to teach checkstyle to ignore my custom javadoc tags?

I have a custom javadoc tag (@todo) attached to some methods and classes. This is what checkstyle says:

[ERROR] Foo.java[0:null] Got an exception - java.lang.IllegalArgumentException: 
the name [todo] is not a valid Javadoc tag name

Is it possible to teach checkstyle to ignore these tags?

I tried to configure as specified here:

<module name="JavadocType">
  <property name="allowUnknownTags" value="true"/>
</module>

But got a message:

... cannot initialize module TreeWalker - Property 
'allowUnknownTags' in module JavadocType does not exist, 
please check the documentation

Moreover, I need to use these tags not only for types, but also for packages, methods, and variables.

ps. It's maven-checkstyle-plugin 2.6

Upvotes: 1

Views: 2213

Answers (1)

dogbane
dogbane

Reputation: 274522

You can't use this property because the Maven Checkstyle Plugin uses Checkstyle 5.0 whereas the allowUnknownTags property was introduced in Checkstyle 5.1. (See the Checkstyle Release Notes)

Upvotes: 2

Related Questions