| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html lang="en"> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page."> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Java Compiler Javadoc Preferences</title> |
| <link rel="stylesheet" href="../../../../book.css" charset="ISO-8859-1" type="text/css"> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> |
| </head> |
| <body> |
| <h1>Java Compiler Javadoc Preferences</h1> |
| <p>Indicate your preferences for the Javadoc settings on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.jdt.ui.preferences.JavadocProblemsPreferencePage)")'> <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="Opens the Javadoc preference page"> |
| <b> Java > Compiler > Javadoc </b></a> preference page.</p> |
| <table border="1" cellspacing="0" cellpadding="5" summary="Javadoc settings"> |
| <thead> |
| <tr> |
| <th> |
| <p>Option</p> |
| </th> |
| <th> |
| <p>Description</p> |
| </th> |
| <th> |
| <p>Default</p> |
| </th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td valign="top"> |
| <p>Process Javadoc comments (includes search and refactoring)</p> |
| </td> |
| <td valign="top"> |
| <p>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.</p> |
| </td> |
| <td valign="top"> |
| <p>On</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p>Malformed Javadoc comments</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, the compiler will issue an error or warning whenever it encounters a malformed Javadoc comment.</p> |
| </td> |
| <td valign="top"> |
| <p>Ignore</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Only consider members as visible as</p> |
| </td> |
| <td valign="top"> |
| <p>The compiler only checks members with the specified or a broader visibility.</p> |
| </td> |
| <td valign="top"> |
| <p>Public</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Validate tag arguments (@param, @throws, @exception, @see, @link)</p> |
| </td> |
| <td valign="top"> |
| <p>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.</p> |
| </td> |
| <td valign="top"> |
| <p>Off</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 2em;"> |
| <p>Report non visible references</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, the compiler will issue an error or warning whenever it encounters a reference to a non visible element.</p> |
| </td> |
| <td valign="top"> |
| <p>Off</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 2em;"> |
| <p>Report deprecated references</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, the compiler will issue an error or warning whenever it encounters a reference to a deprecated element.</p> |
| </td> |
| <td valign="top"> |
| <p>Off</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Missing tag descriptions</p> |
| </td> |
| <td valign="top"> |
| <p>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</p> |
| </td> |
| <td valign="top"> |
| <p>'Validate @return tags'</p> |
| </td> |
| </tr> |
| |
| <tr> |
| <td valign="top"> |
| <p>Missing Javadoc tags</p> |
| </td> |
| <td valign="top"> |
| <p>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).</p> |
| </td> |
| <td valign="top"> |
| <p>Ignore</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Only consider members as visible as</p> |
| </td> |
| <td valign="top"> |
| <p>The compiler only checks members with the specified or a broader visibility.</p> |
| </td> |
| <td valign="top"> |
| <p>Public</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Ignore in overriding and implementing methods</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, methods that override or implement another method are not checked for missing Javadoc tags.</p> |
| </td> |
| <td valign="top"> |
| <p>On</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Ignore method type parameters</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, missing Javadoc tags are not reported for method type parameters.</p> |
| </td> |
| <td valign="top"> |
| <p>On</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top"> |
| <p>Missing Javadoc comments</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, the compiler will issue an error or warning whenever it encounters a missing Javadoc comment for a Java member.</p> |
| </td> |
| <td valign="top"> |
| <p>Ignore</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Only consider members as visible as</p> |
| </td> |
| <td valign="top"> |
| <p>The compiler only checks members with the specified or a broader visibility.</p> |
| </td> |
| <td valign="top"> |
| <p>Public</p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" style="padding-left: 1em;"> |
| <p>Ignore in overriding and implementing methods</p> |
| </td> |
| <td valign="top"> |
| <p>When enabled, methods that override or implement another method are not checked for missing Javadoc comments.</p> |
| </td> |
| <td valign="top"> |
| <p>On</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </body> |
| </html> |
