Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Java Development User Guide
Previous Page Home Next Page

Java Compiler Javadoc Preferences

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. For search and refactoring to work on Javadoc comments it is also required to enable this option.

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

Validate tag arguments (@param, @throws, @exception, @see, @link)

When enabled, the compiler will issue an error or warning whenever it encounters an error in a Javadoc comment tag argument for @param, @throws, @exception, @see or @link.

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 tag descriptions

Choose between 'Validate all standard tags', 'Validate @return tags' and 'Ignore'. When enabled, the compiler will issue an error or warning whenever it encounters a missing tag description

'Validate @return tags'

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


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire