Javadoc declaration problems
Reports Javadoc comments and tags with the following problems:
invalid tag names
incomplete tag descriptions
duplicated tags
missing Javadoc descriptions
Example:
Example:
Quick-fix adds the unknown Javadoc tag to the list of user defined additional tags.
Use textfield below to define additional Javadoc tags.
Use first checkbox to ignore duplicated 'throws' tag.
Use second checkbox to ignore problem with missing or incomplete first sentence in the description.
Use third checkbox to ignore references pointing to itself.
Inspection options
Option | Type | Default |
---|---|---|
Additional Javadoc tags | ExpandableString | |
Ignore duplicate 'throws' tag | Checkbox | true |
Ignore period problems | Checkbox | true |
Ignore Javadoc pointing to itself | Checkbox | false |
Ignore elements marked as @deprecated | Checkbox | false |
Inspection Details | |
---|---|
Available in: | IntelliJ IDEA 2023.3, Qodana for JVM 2023.3 |
Plugin: | Java, 233.SNAPSHOT |