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.
Locating this inspection
- By ID
Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.
javadoc- Via Settings dialog
Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.
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
Here you can find the description of settings available for the Javadoc declaration problems inspection, and the reference of their default values.
- Additional Javadoc tags
Default value:
Empty- Ignore duplicate 'throws' tag
Default value:
Selected- Ignore period problems
Default value:
Selected- Ignore Javadoc pointing to itself
Default value:
Not selected- Ignore elements marked as @deprecated
Default value:
Not selected
Suppressing Inspection
You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:
More detailed instructions as well as other ways and options that you have can be found in the product documentation:
Inspection Details | |
|---|---|
By default bundled with: |