CODEWITHSUNDEEP
zend-frameworknetbeansphpdoc
MEM
MEM

Reputation: 31307

How to generate phpDoc documentation for a specific folder in Netbeans IDE?

Due to the fact that we need to integrate the Zend Framework on our project root, and that generating that documentation will be useless and take long time, I would like to generate documentation for all files inside application folder only.

Does anyone know how I can generate documentation for a specific project folder, trough Netbeans 7.0 interface?

Update: The best I've found so far was to:

Open the terminal window from netbeans, and type:

sudo phpdoc -d public_html/yoursite.dev/application/ -t public_html/yoursite.dev/docs/

Update 2 Let's suppose our Zend library is inside projectrootname/library/Zend we also can try, by going to: Tools > Options > Php > PhpDoc and place the following:

/usr/bin/phpdoc -i library/Zend/ -o HTML:frames:earthli

At least for me, that doesn't seem to work, because, when I try to generate the documentation, I get permission error issues displayed on the output window.

Thanks

Upvotes: 3

Views: 5327

Answers (1)

ashnazg
ashnazg

Reputation: 6688

The -d/--directory option [1] should be used to highlight the most high-level code directory that you want phpDocumentor to start reading from. If your Zend folder is at or above the level of your application directory, then just using --directory /path/to/application should help you document only your application code.

If your Zend folder is somewhere inside your application (e.g. in your app's ./lib folder), then you can use the -i/--ignore option [2] to tell phpDocumentor about any directories that it will see but should ignore, --ignore *zend*. Just be aware that formatting your ignore value can be tricky, so see the examples in the manual. Also, be aware that as phpDocumentor runs, you will see these ignored folders and files being listed in the output... phpDocumentor "ignores" them by not generating docs for those files. It does, however, still need to parse them, in case those objects are referenced in files that do get documented.

[1] -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.directory

[2] -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.ignore

Upvotes: 3

Related Questions