Reputation: 31
I want to use PHP Documentor on my codeigniter project. I installed phpdocs via pear, and I tried to use it by running the following in my application directory:
phpdoc -d controllers
All methods are commented like docblocks
.
My result is a folder with index.html file, but when I open in I cannot enter any of my classes. It returns me an error:
file not found
What is more, my clasess directory is empty. Out of curosity I tried using phpdoc on my clean php file and it shows me normal documentation.
Can somebody give me instructions how to use phpdoc on codeigniter project? Maybe there is other software which gives similar results?
Upvotes: 0
Views: 326
Reputation: 6688
If the classes are automatically generated by the framework, see if the docblocks contain @internal
or @ignore
. If the former, then use the --parseprivate
arg. If the latter, you'll have to manually remove that tag.
I can't think of any other reasons why no docs would be generated.
Upvotes: 0