PHPDocumentor Preferences

The PHPDocumentor Preferences page allows you to add, edit or remove, a PHPDocumentor profile.

The PHPDocumentor Preferences page is accessed from Window | Preferences | PHP | PHPDocumentor Profile .

How do I generate a PHPDoc?

Configuring PHPDoc Profiles

This procedure describes how to create and use different PHPDoc profiles.



Instructions on how to complete a procedure

To configure your PHPDoc profiles:

  1. In the menu-bar, go to Window | Preferences | PHP | PHPDocumentor Profile.
    The PHPDocumentor Profile preferences page is displayed.
  1. To create a new profile, click New. To configure an existing profile, click the Profile drop-down menu, and select the profile you wish to edit (skip to step 5).
    The New PHPDocumentor Profile dialog is displayed.

  1. Name your new profile, and select the profile you want to initialize it from.
  2. Click OK.
  3. Configure your profile:
  • Doc title - Enter a title for the generated PHPDoc (default: Example title).
  • Default package - Enter a name for the default package (default: Example default package name).
  • Markers - Enter a list of markers to be included in the generated PHPDoc (default: TODO, FIXME).
  • Extensions - Enter a list of file extensions to be included in the generated PHPDoc (default: php, phtml).
  • Ignore patterns - Enter a list of file patterns to be excluded (e.g., tests/*).
  • Template - Select a template for the generated PHPDoc. Use the adjacent window to preview each template.
  • Logging level - Select the minimum level of information to be logged.
  1. Click Apply to save your profile, and OK to exit the Preferences dialog.


To configure a project specific profile, click Configure Project Specific Settings in the top-right corner of the preferences page. This sets the default profile to be used when generating a PHPDoc for a specific project.