phpdocumentor 2 and phpstorm 5
Hello, I'd like to know if this tutorial is still valid to generate documentation with phpDocumentor 2 and phpstorm 5:
http://www.phpdoc.org/docs/latest/for-users/integrating-with-your-ide.html
Will it automatically creates a file containing the documentation?
Best regards
Please sign in to leave a comment.
Hi aurelien,
It should (worked fine back then http://devnet.jetbrains.net/message/5455843 ) -- you just need to use correct names (since it is not a docblox any more but phpDocumentor 2, so names shoulc be slightly different, right?).
I have it up and working in Windows (Win7Prox64). Here's what I did:
- You'll need to have a php interpreter set up in phpstorm, should also be in the path
- Get the php cli up and running...the cli may not follow the same php.ini as the server and it MUST have XSL module enabled!
- You'll need to have the phpDocumentor2 installed...I've found PEAR worked the best, but had to install PEAR on my system first.
- Create a new external tool
-- In Program, insert a macro for the $PhpExecutable$
-- In Parameters enter something like $PhpExecutable$\..\phpdoc.php run -d "$ProjectFileDir$"
-- In Working directory, insert a macro for the $ProjectFileDir$
Then you'll need to create a phpdoc.xml configuration file in the project directory or allow it to use the system defaults.
I then add the external tool to the toolbar.
Hello, I am using mac os x with mamp.
We must do something in particular? I did not find information for my setup
Best regards
Like this?
Attachment(s):
phpdoc2.png
MacOS uses / not \ as path separators