Indicate your preferences for the Javadoc settings on the
Java > Compiler > Javadoc preference page.
Option |
Description |
Default |
---|---|---|
Process Javadoc comments (includes search and refactoring) |
The builder detects problems in Javadoc comments if this option is enabled. |
On |
Malformed Javadoc comments |
When enabled, the compiler will issue an error or warning whenever it encounters a malformed Javadoc comment. |
Ignore |
Only consider members as visible as |
The compiler does only check members with the specified or a broader visibility. |
Public |
Report errors in tags |
When enabled, the compiler will issue an error or warning whenever it encounters an error in a Javadoc comment tag. |
Off |
Report non visible references |
When enabled, the compiler will issue an error or warning whenever it encounters a reference to a non visible element. |
Off |
Report deprecated references |
When enabled, the compiler will issue an error or warning whenever it encounters a reference to a deprecated element. |
Off |
Missing Javadoc tags |
When enabled, the compiler will issue an error or warning whenever it encounters a missing Javadoc tag (i.e. missing @param tag for a parameter). |
Ignore |
Only consider members as visible as |
The compiler does only check members with the specified or a broader visibility. |
Public |
Check overriding and implementing methods |
When enabled, also overriding and implementing methods are checked for missing Javadoc tags. |
Off |
Missing Javadoc comments |
When enabled, the compiler will issue an error or warning whenever it encounters a missing Javadoc comment for a Java member. |
Ignore |
Only consider members as visible as |
The compiler does only check members with the specified or a broader visibility. |
Public |
Check overriding and implementing methods |
When enabled, also overriding and implementing methods are checked for missing Javadoc comments. |
Off |