-
-
Notifications
You must be signed in to change notification settings - Fork 640
Description
I'm trying really hard to figure out how to use phpdoc, but it's difficult because the documentation on docs.phpdoc.org is awful - it only covers a tiny fraction of the available options, it's really hard to find anything in it, and some of the links don't even work!
For instance, I'm trying to figure out what templates are. Currently I have no idea, because the templates link in the docs gives a 404 error. I eventually managed to find a page at https://www.phpdoc.org/templates, which appears to be a carousel of screenshorts, so I'm guessing that templates have to do with styling the output? I don't know. How do I use them? What do they do? Can I add my own?
I wasted a half hour trying to figure out why I was getting a screen full of error messages when I tried to run it, before I discovered that I was using parse instead of run, and failing to set a target directory (which appears to be mandatory, even though nothing tells me that).
I'm getting really frustrated, and the only reason I haven't given up on it completely, is that the only alternative I've been able to find is doxygen, which is even more complicated to use than phpdoc.
It's a really poor showing, when a documentation tool has such bad documentation.
I'm sure this is a great tool for the 115 people who know how it works internally, but for everyone else? We need better instructions.