benmatselby / sublime-phpdocumentor

[DEPRECATED] phpDocumentor Support for Sublime Text 2

Sublime phpDocumentor

Installation

Use Sublime Text 2's Package Control (Preferences -> Package Control -> Install Package -> phpDocumentor) to install this plugin.

phpDocumentor Support For Sublime Text 2

This plugin adds support for running phpDocumentor 2 from inside Sublime Text 2.

Right-click in the side-bar to:

• Generate documentation

Sublime phpDocumentor support is based on: PHPUnit plugin which is based on Ruby Tests plugin

Configuration

You can configure:

• additional_args - This is the extra information you want to pass to the phpdoc command
• executable_path - The path to the phpdoc executable. If empty string, use PATH to find it

Contributions Welcome

Requests for features, and pull requests with patches, are most welcome.

sublime-phpdocumentor's Issues

Support for ST3

This plugin will need to be ported to STv3: http://www.sublimetext.com/docs/3/porting_guide.html

Impossible to ignore several files

Hi,
Firstly I want to thank you for your work: it's really cool to generate documentation within SublimeText!

Unfortunately I've got a problem with this package. I want to ignore some specific files but it doesn't work (It's ok when trying to ignore only one file).
I use the "additional_args" parameter that way but I also tried to use "-i":

"additional_args": {
    "--ignore": "directory/file1.php,directory/file2.php"
}

and the generated command line is:

phpdoc --ignore=directory/file1.php,directory/file2.php -d /PATH/TO/MY/PROJECT -t /PATH/TO/MY/PROJECT/build/api/ -i /PATH/TO/MY/PROJECT/build/api/

If I modify this command to remove the last -i parameter it works!