In this dialog you set project properties for documentation generated by
ApiGen. You must have ApiGen installed. You must configure NetBeans
IDE for PHP to use ApiGen, in Tools > Options > PHP > ApiGen (On MacOS,
this is NetBeans Preferences > PHP > ApiGen).
Manual Configuration or Configuration File
Select either to configure ApiGen manually, in this dialog, or to use a configuration
file. If you select a configuration file, enter the path to an ApiGen configuration
file in the Configuration field.
The configuration file contains parameters that are passed when you run ApiGen. You can set options in the configuration file that are not available in this dialog. For a full list of options, see .
Manual Configuration
You can set the following parameters in this dialog:
Target Directory: The directory containing the generated
ApiGen documentation.
Browse... Browse your file system for a target directory.
Title: The title of the generated documentation.
Configuration. Optional.
Any parameters you define elsewhere in this
dialog override parameters defined in a configuration file.
Charsets. 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.
Exclude. Optional. If you specify a file mask in this field,
ApiGen will not parse files matching this file mask.
Access Levels. Access levels of methods and properties for
which ApiGen generates documentation. By default, ApiGen does not generate
documentation for private methods or properties.
Internal. Select to generate documentation for elements
marked internal by an @internal annotation.
PHP. Select to generate documentation for PHP internal
classes.
Tree. Select to generate tree view of classes, interfaces,
traits and exceptions.
Deprecated. Select to generate documentation for deprecated
elements.
TODO. Select to generate a list of tasks.
Download. Select to create a ZIP archive of documentation and
a download link for this ZIP archive.
Source Code. Select to generate highlighted source code for
user-defined elements.