| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
| <head> |
| <title>Standard Java SE Project Properties Dialog Box: Documenting</title> |
| <link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/> |
| </head> |
| |
| <body> |
| <p><a id="org.netbeans.modules.java.j2seproject.ui.customizer.CustomizerJavadoc" name="org.netbeans.modules.java.j2seproject.ui.customizer.CustomizerJavadoc"></a></p> |
| <div id="NBCSH2105"><!-- infolevel="all" infotype="General" --><a id="sthref287" name="sthref287"></a> |
| <h1>Standard Java SE Project Properties Dialog Box: Documenting</h1> |
| <a name="BEGIN" id="BEGIN"></a> |
| <p>Use to configure how the IDE generates Javadoc documentation for your classes. |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG373"> |
| <param name="text" value="<html><u>How?</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| |
| <table summary="Description of documentation configuration options" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <col width="38%" /> |
| <col width="*" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t16">Element</th> |
| <th align="left" valign="bottom" id="r1c2-t16">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t16" headers="r1c1-t16"> |
| <p>Include Private and Package Private Members</p> |
| </td> |
| <td align="left" headers="r2c1-t16 r1c2-t16">Generates Javadoc for all members, including private ones. |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2103"> |
| <param name="text" value="<html><u>More</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| |
| <p>This option is unselected by default, because Javadoc is generated only for public members.</p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t16" headers="r1c1-t16"> |
| <p>Generate</p> |
| </td> |
| <td align="left" headers="r3c1-t16 r1c2-t16">Includes the selected elements in the generated HTML document, such as index, navigation bar, class hierarchical tree, and such.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t16" headers="r1c1-t16"> |
| <p>Document Additional Tags</p> |
| </td> |
| <td align="left" headers="r4c1-t16 r1c2-t16">Documents the selected tags. |
| <p>The tags listed are not documented by default.</p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r5c1-t16" headers="r1c1-t16"> |
| <p>Browser Window Title</p> |
| </td> |
| <td align="left" headers="r5c1-t16 r1c2-t16">Displays the title in the browser window used to view the generated document. You must enter the title to be placed in the <code dir="ltr"><title></code> tag of the generated HTML document. |
| <p>This checkbox corresponds to the <code dir="ltr">-windowtitle</code> Javadoc option.</p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r6c1-t16" headers="r1c1-t16"> |
| <p>Additional Javadoc Options</p> |
| </td> |
| <td align="left" headers="r6c1-t16 r1c2-t16">Adds additional Javadoc options separated with a space.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r7c1-t16" headers="r1c1-t16"> |
| <p>Preview Generated Javadoc</p> |
| </td> |
| <td align="left" headers="r7c1-t16 r1c2-t16">Opens the generated document automatically in your default browser window.</td> |
| </tr> |
| </tbody> |
| </table> |
| <br /> |
| <!-- --> |
| <p>For more information on generating Javadoc documentation, see <code dir="ltr"> |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html"> |
| <param name="text" value="<html><u>http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </code>.</p> |
| <a id="NBCSH2112" name="NBCSH2112"></a> |
| <hr><p><b>Related Topics</b></p> |
| <p>Developing Applications with NetBeans IDE, |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG370"> |
| <param name="text" value="<html><u>"Using Java Project Templates"</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| |
| <!-- --> |
| <!-- Start Footer --> |
| |
| |
| <table summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td align="left" width="86%"><a href="legal_notice.htm"> |
| Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a> |
| </td> |
| </tr> |
| </table> |
| <!-- --> |
| </body> |
| </html> |
