Re: Is your package Documented ?

--- Ian Eure <ieure@php.net> wrote: > On Tuesday 13 April 2004 11:48 am, David Costa wrote: > > Documentation can be automatically-generated using PHPDocumentor > > http://pear.php.net/package/PhpDocumentor/ > > > The documentation I've seen PHPDocumentor produce differs substantially from > the user-friendly docs in the PEAR manual. The PHPDoc page also makes this > claim, but doesn't explain how to generate such documentation. Look at (the tinyfied) URL: http://www.6url.com/GK (*) (*) Full URL is: http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.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 > Perhaps a guide on this subject would get more package documentation in the > PEAR manual. The above + the info in http://pear.php.net/manual/en/developers.contributing.docs.php http://www.php.net/dochowto http://cvs.php.net/co.php/peardoc/en/guide/developers/documentation.xml?r=1.12 (last one should be in the main manual, but could not find in the current online version) ===== -- 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