| <!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>Java ME Embedded 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.j2me.project.ui.customizer.J2MEJavadocPanel" name="org.netbeans.modules.j2me.project.ui.customizer.J2MEJavadocPanel"></a></p> |
| <div id="NBCSH5318"><!-- infolevel="all" infotype="General" --><a id="sthref788" name="sthref788"></a> |
| <h1>Java ME Embedded Project Properties Dialog Box: Documenting</h1> |
| <a name="BEGIN" id="BEGIN"></a> |
| <p>Use to configure how the IDE generates Javadoc documentation for each of your projects. For each of your projects, you can produce a set of Javadoc HTML pages that describe the project's classes, inner classes, interfaces, constructors, methods, and fields. The Javadoc is constructed from the structure of your code and the Javadoc comments embedded in your code. |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1584"> |
| <param name="text" value="<html><u>How?</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| |
| <table summary="Descriptions of elements in Generating Javadoc page of Project Properties dialog box." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <col width="33%" /> |
| <col width="*" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t30">Element</th> |
| <th align="left" valign="bottom" id="r1c2-t30">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t30" headers="r1c1-t30"> |
| <p>Include Private and Package Private Members.</p> |
| </td> |
| <td align="left" headers="r2c1-t30 r1c2-t30">Indicates that private and package private members are documented.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t30" headers="r1c1-t30"> |
| <p>Generate</p> |
| </td> |
| <td align="left" headers="r3c1-t30 r1c2-t30">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-t30" headers="r1c1-t30"> |
| <p>Document Additional Tags</p> |
| </td> |
| <td align="left" headers="r4c1-t30 r1c2-t30">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-t30" headers="r1c1-t30"> |
| <p>@author</p> |
| </td> |
| <td align="left" headers="r5c1-t30 r1c2-t30">Documents the author tag.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r6c1-t30" headers="r1c1-t30"> |
| <p>@version</p> |
| </td> |
| <td align="left" headers="r6c1-t30 r1c2-t30">Documents the version tag.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r7c1-t30" headers="r1c1-t30"> |
| <p>Browser Window Title</p> |
| </td> |
| <td align="left" headers="r7c1-t30 r1c2-t30">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="r8c1-t30" headers="r1c1-t30"> |
| <p>Additional Javadoc Options</p> |
| </td> |
| <td align="left" headers="r8c1-t30 r1c2-t30">Adds additional Javadoc options separated with a space.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r9c1-t30" headers="r1c1-t30"> |
| <p>Preview Generated Javadoc</p> |
| </td> |
| <td align="left" headers="r9c1-t30 r1c2-t30">Indicates that when Javadoc is generated, a browser is opened displaying the generated documents</td> |
| </tr> |
| </tbody> |
| </table> |
| <br /> |
| <!-- --> |
| <p>For more information on the Java API Documentation Generator, see: <code dir="ltr"> |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html"> |
| <param name="text" value="<html><u>http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </code>.</p> |
| <a id="NBCSH5327" name="NBCSH5327"></a> |
| <hr><p><b>Related Topics</b></p> |
| <p><i>Developing Applications with NetBeans IDE</i>, |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG461"> |
| <param name="text" value="<html><u>"Adding Javadoc to a Project"</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> |
