Home/ Questions/Q 3359962
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-18T02:56:10+00:00

I have a custom javadoc tag ( @todo ) attached to some methods and

  • 0

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

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    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)

    • 0