Re: PHPDocumentor
| From: | Jesus M. Castagnetto | Date: | Tue, 10 Jun 2003 16:21:25 +0000 |
| Subject: | Re: PHPDocumentor | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-5880@lists.php.net to get a copy of this message | ||
Ehem,
Sparse? Did you visit phpdoc.org? if not, don't walk, run and go there ;-)
You will find a complete tutorial and the user's manual there, and you can pick
what template to use while reading it: http://phpdoc.org/docs/
I usually use an invokation such as:
$ phpdoc -d /path/to/phpcode -t /path/to/generated/apidoc --pear -ti 'Name of
package' -o 'HTML:frames:default,HTML:frames:l0l33t'
To get some help use:
$ phpdoc -h
Where phpdoc is the script in the 'bin' subdir of the dir where your PHP libs,
etc. get installed.
The web interface is nice, but I had not used it in many moons. Gotten used to
the command line interface.
Happy reading and documenting.
--- Joel Allyn Cron <jacron0@uky.edu> wrote:
> I find it rather funny that the Documentation for the Documentor is rather
> sparse about how to actually use the tool. The user interface on the web
> interface is mind boggling to a new user (me, for instance). I've been
> messing with it for a couple of hours and (embarassingly enough) I haven't
> gotten it to make docs for itself yet.
=====
--- Jesus M. Castagnetto (jcastagnetto@yahoo.com)
Research:
http://metallo.scripps.edu/
Personal: http://www.castagnetto.org/
__________________________________
Do you Yahoo!?
Yahoo! Calendar - Free online calendar with sync to Outlook(TM).
http://calendar.yahoo.com