Documentation Wizard helps you generate API documentation for your application from PHPDoc comments in your code. You can access the dialog from Tools > Documentation Wizard. The wizard gives you these options:
- Input Information
Item Description Documentation Title Is the title for your documentation project, used both in the top menu an the main page. Source Folder Documentation will be generated from the files found in this folder. It defaults to your project’s source folder. Files to ignore Comma-separated list of files on the source folder to be ignored when generating the documentation. You can use wilcards: * (any number of characters) and ? (single character). Samples Folder Path to the folder containing sample code files referenced from your source code documentation. Default Package Name Package name for those classes for which @package is not set.
- Output Information
Item Description Output Folder Generated documentation will be placed inside this folder. Output Type Output format. You can choose between CHM (Windows Help File), HTML (default), PDF and XML. Converter Converter to be used, to choose between frames (default) and Smarty (phpDocumentor template engine). Template Template to use. rpcl (default) recognizes properties, events, and more. Available templates will depend on the converter you choose. Generate Highlighted Source Code Whether or not source code should use syntax highlight. This option is enabled by default.
Set those settings so them fit your projects, and click Generate Documentation once you are ready.