|
The quickest way to understand how Java code is structured |
Use the Javadoc tag to indicate that a Java element should be declared with a javadoc comment in order for it be included in the parent element selector.
| Attribute | Description | Required |
|---|---|---|
| name | the name of the javadoc tag as denoted with the @ symbol | No |
| valuePattern | a wildcard pattern to which the value (the text after the @name) must conform | No |
| valuePatternSwitch | the name of a switch pattern as declared by the parent element selector | No |
| anded | give up assessing the Java element against sibling criteria if this one fails | No |
TypeSelector, MethodSelector or FieldSelector
<FieldSelector name="sinceFields">
<Javadoc name="since"/>
</FieldSelector>
Declares a field selector which accepts fields with an @since javadoc tag.
<FieldSelector name="sinceV2Fields"> <Javadoc name="since" anded="true"/>Declares a field selector which accepts only fields with javadoc @since 2.0
<Javadoc valuePattern="2.0" anded="true"/>
</FieldSelector>
<FieldSelector name="sinceVersionFields" requiredSwitches="version"> <Javadoc name="since" anded="true"/>Declares a field selector which accepts only fields with javadoc @since xxx where xxx is a version string passed to the field selector.
<Javadoc valuePatternSwitch="version" anded="true"/>
</FieldSelector>
