Re: PHPDoc Standards
| From: | Pierre-Alain Joye | Date: | Sun, 11 Aug 2002 01:01:28 +0000 |
| Subject: | Re: PHPDoc Standards | ||
| References: | 1 2 3 4 5 6 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-8287@lists.php.net to get a copy of this message | ||
On Sun, 11 Aug 2002 02:47:05 +0200
alexander.merz@t-online.de (Alexander Merz) wrote:
> Pierre-Alain Joye wrote:
>
>
> > Sure, as well there is a place in pear manuel about how to generate a reference from a
> > package.
> > Certainly a place in the new developer's guide from Martin.
>
> Originally, while thinking about the phpdoc2pearmanual tool, i have the
> idea of:
>
> pd2pm package.1.2.tgz
>
> which creates the pages with the informations from package.xml and the
> phpdoc comments.
> Unfortunatly the PEAR-Installer-classes are not really documentated, so
> this kind of calling is more a new point for the ToDo list.
>
> PS: How to get the whole content of package.xml with the installer-class
> without installing the package itself?
Well, not really possible directly. The uncompressfunction as well as the install ones and all
others stuffs are in the same function (available in /usr/local/lib/php/PEAR/Installer.php ). It is
not so difficult to extract the essence of this function to build a phpdoc wrapper command.
Well, as actually working on a DocConvert command line, it sounds good to add the phpdoc tools to
it.
Actually it is near to work (debugging consoles mode :) ) and looks like :
Converting a OpenOffice document to DocBook using DOM parser :
docconvert convert dom -o ./doc1.xml doc1.sxw
Converting a OpenOffice document to DocBook using XML_Tree (not yet implemented :) ) parser :
docconvert convert xml_tree -o ./doc1.xml doc1.sxw
For phpdoc, I can imagine something :
docconvert convert php_doc -o ./doc1.xml mypackage
and will look in the current folder for the package, or get it from the web.
just ideas, comments welcome
pa