Re: Is your package Documented ?
| From: | Jesus M. Castagnetto | Date: | Wed, 14 Apr 2004 09:53:17 +0000 |
| Subject: | Re: Is your package Documented ? | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-27623@lists.php.net to get a copy of this message | ||
--- Clay Loveless <clay@killersoft.com> wrote:
> From: "Jesus M. Castagnetto" <jcastagnetto@yahoo.com>
> >
> > Look at (the tinyfied) URL: http://www.6url.com/GK (*)
> >
> > (*) Full URL is:
> >
>
http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpD
> > ocumentor.howto.pkg.html#using.command-line.output
> >
> > Basically you need to use the XML:DocBook/peardoc2:default renderer and
> give
> > the other approrpiate parameters to the 'phpdoc' command.
> >
> > That renderer seems to be much better nowadays. I'll try some of my
> > undocumented packages (although I do have the API docs on my site, linked
> from
> > pear.php.net/user/jesus
Typo alert: pear.php.net/user/jmcastagnetto,
The docs are at a web page at my old job (generated with an older version of
PhpDocumentor): http://www.scripps.edu/~jesusmc/pear/docs/index.html
> I found this e-mail to be particularly helpful -- thanks for the point in
> the right direction in the phpdoc docs!
>
> Something else that I would find helpful (perhaps others would as well) -- a
> list of recommended settings for a phpDocumentor .ini file?
>
> In other words, what would the minimum preferred phpDocumentor .ini settings
> be to generate well-received, easy-to-import into peardoc documentation?
I just added to CVS a file like that in Math_Complex/math_complex.ini to
generate the HTML and XML Docbook. It is basically a mangled copy from the
default.ini (PHP_DIR/lib/php/data/PhpDocumentor/user/default.ini) that comes
with PhpDocumentor. On purpose I've left Greg's comments there.
Cheers.
/me goes to sleep after finishing submission of taxes
=====
--
Jesus M. Castagnetto (jcastagnetto@yahoo.com)
Research: http://metallo.scripps.edu/
Personal: http://www.castagnetto.org/
PEAR stuff: http://pear.php.net/user/jmcastagnetto
__________________________________
Do you Yahoo!?
Yahoo! Tax Center - File online by April 15th
http://taxes.yahoo.com/filing.html