| <!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>Project Properties Window: ApiGen</title> |
| <link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/> |
| </head> |
| |
| <body> |
| <p><a id="org.netbeans.modules.php.apigen.ui.customizer.ApiGen" name="org.netbeans.modules.php.apigen.ui.customizer.ApiGen"></a></p> |
| <div id="NBCSH3566"><!-- infolevel="all" infotype="General" --><a id="sthref483" name="sthref483"></a> |
| <h1>Project Properties Window: ApiGen</h1> |
| <a name="BEGIN" id="BEGIN"></a> |
| <p>In this pane you can set the project properties for documentation generated by ApiGen. You must have ApiGen installed. You can configure the IDE to use ApiGen in the Frameworks & Tools tab of the PHP category in the Options window.</p> |
| <p>In this panel you can set the following ApiGen properties:</p> |
| |
| <table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <col width="24%" /> |
| <col width="*" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t19">Element</th> |
| <th align="left" valign="bottom" id="r1c2-t19">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t19" headers="r1c1-t19"> |
| <p>Manual Configuration</p> |
| </td> |
| <td align="left" headers="r2c1-t19 r1c2-t19">Select this option to manual configure the ApiGen Properties.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t19" headers="r1c1-t19"> |
| <p> Target Directory</p> |
| </td> |
| <td align="left" headers="r3c1-t19 r1c2-t19">The directory containing the generated ApiGen documentation. |
| <p>Click Browse to locate the target directory on your local file system.</p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t19" headers="r1c1-t19"> |
| <p> Title</p> |
| </td> |
| <td align="left" headers="r4c1-t19 r1c2-t19">The title of the generated documentation.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r5c1-t19" headers="r1c1-t19"> |
| <p> Charsets</p> |
| </td> |
| <td align="left" headers="r5c1-t19 r1c2-t19">Character set of source files. You can specify a comma-separated list of character sets if your PHP project uses more than one character set.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r6c1-t19" headers="r1c1-t19"> |
| <p> Excludes</p> |
| </td> |
| <td align="left" headers="r6c1-t19 r1c2-t19">Optional. If you specify a file mask in this field, ApiGen will not parse files matching this file mask.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r7c1-t19" headers="r1c1-t19"> |
| <p> Access Levels</p> |
| </td> |
| <td align="left" headers="r7c1-t19 r1c2-t19">Access levels of methods and properties for which ApiGen generates documentation. By default, ApiGen does not generate documentation for private methods or properties.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r8c1-t19" headers="r1c1-t19"> |
| <p> Internal</p> |
| </td> |
| <td align="left" headers="r8c1-t19 r1c2-t19">Select to generate documentation for elements marked internal by an <code dir="ltr">@internal</code> annotation.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r9c1-t19" headers="r1c1-t19"> PHP</td> |
| <td align="left" headers="r9c1-t19 r1c2-t19">Select to generate documentation for PHP internal classes.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r10c1-t19" headers="r1c1-t19"> Tree</td> |
| <td align="left" headers="r10c1-t19 r1c2-t19">Select to generate tree view of classes, interfaces, traits and exceptions.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r11c1-t19" headers="r1c1-t19"> Deprecated</td> |
| <td align="left" headers="r11c1-t19 r1c2-t19">Select to generate documentation for deprecated elements.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r12c1-t19" headers="r1c1-t19"> Todo</td> |
| <td align="left" headers="r12c1-t19 r1c2-t19">Select to generate a list of tasks.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r13c1-t19" headers="r1c1-t19"> Download</td> |
| <td align="left" headers="r13c1-t19 r1c2-t19">Select to create a ZIP archive of documentation and a download link for this ZIP archive.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r14c1-t19" headers="r1c1-t19"> Source Code</td> |
| <td align="left" headers="r14c1-t19 r1c2-t19">Select to generate highlighted source code for user-defined elements.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r15c1-t19" headers="r1c1-t19">Configuration File</td> |
| <td align="left" headers="r15c1-t19 r1c2-t19">Select this option to specify an ApiGen configuration file that contains the parameters that are passed when you run ApiGen. You can set options in the configuration file that are not available in this dialog. |
| <p>Click Browse to locate the configuration file on your local file system.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /> |
| <!-- --> |
| <a id="NBCSH3574" name="NBCSH3574"></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=NBDAG1534"> |
| <param name="text" value="<html><u>"About Developing PHP Applications"</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> |
