Class WriteTagCheck

Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets that sort the report by author name. To define the format for a tag, set property tagFormat to a regular expression. This check uses two different severity levels. The normal one is used for reporting when the tag is missing. The additional one (tagSeverity) is used for the level of reporting when the tag exists. The default value for tagSeverity is info.

An example of how to configure the check for printing author name is:

 <module name="WriteTag">
    <property name="tag" value="@author"/>
    <property name="tagFormat" value="\S"/>
 </module>
 

An example of how to configure the check to print warnings if an "@incomplete" tag is found, and not print anything if it is not found:

 <module name="WriteTag">
    <property name="tag" value="@incomplete"/>
    <property name="tagFormat" value="\S"/>
    <property name="severity" value="ignore"/>
    <property name="tagSeverity" value="warning"/>
 </module>
 

Version: 1.0

Author: Daniel Grenner