Re: PHPDocumentor
| From: | Joshua Eichorn | Date: | Tue, 10 Jun 2003 17:34:10 +0000 |
| Subject: | Re: PHPDocumentor | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-5885@lists.php.net to get a copy of this message | ||
In case anyone wonders the problem he was running into is documentation that uses source highlighting in tutorial sections won't work in php < 4.3.0 (or 4.3.0 > with the tokeniezer turned off). You just get a bunch of errors on missing constants.
Hopefully i can get this and a couple of other small bugs fixed this week.
-joshua eichorn
Joel Allyn Cron wrote:
I can't get 'pear install <package_name> to work for some reason. It has trouble with the download, no matter what package I'm trying to download. I did install it from a local tarball and that was fine. I was having trouble with using phpdoc.php from there, though, so I gave up and used tarball from sourceforge. Josh Eichorn just emailed me and explained my problem to me. Thanks for all the help. Joel -----Original Message----- From: "Jesus M. Castagnetto" <jcastagnetto@yahoo.com> To: jacron0@uky.edu Date: Tue, 10 Jun 2003 10:15:11 -0700 (PDT) Subject: Re: Re: [PEAR] PHPDocumentor Are you trying to install manually from the tarball? Why not use the PEAR installer, now that PhpDocumentor has a package.xml included? --- Joel Allyn Cron <jacron0@uky.edu> wrote:I agree the Docs on how to use their tool to document are good. I'm on my third try at installing, however, and their INSTALL and README are ridiculously sparse. Maybe I'll let you know when it's finally installed for good.Try: pear install PhpDocumentor or even pear install name-of-local-tarball.tgz That's all I had to do both on my Solaris box at work, and on my Linux machine at home. Just make sure that you have a current PEAR and Archive_Tar. See the similar thread at: http://marc.theaimsgroup.com/?t=105516803800003&r=1&w=2-----Original Message----- From: "Jesus M. Castagnetto" <jcastagnetto@yahoo.com> To: jacron0@uky.edu, pear-general@lists.php.net Date: Tue, 10 Jun 2003 09:21:25 -0700 (PDT) Subject: Re: [PEAR] PHPDocumentor 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:===== --- 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.comI 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 -- PEAR General Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php -- PEAR General Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php