Project Properties Window: ApiGen

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.

In this panel you can set the following ApiGen properties:

Element Description

Manual Configuration

Select this option to manual configure the ApiGen Properties.

    Target Directory

The directory containing the generated ApiGen documentation.

Click Browse to locate the target directory on your local file system.

    Title

The title of the generated documentation.

    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.

    Excludes

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.

Configuration File

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.

Click Browse to locate the configuration file on your local file system.



Related Topics

Developing Applications with NetBeans IDE,

Copyright © 2014, Oracle and/or its affiliates. All rights reserved.