Re: PEAR Guide/Docs

On Fri, 2003-03-28 at 00:31, Bertrand Mansion wrote: > What's the difference between peardoc and peardoc 2 ? Peardoc2 has replaced peardoc and is now called peardoc actually. > Why was it decided to > change versions ? The new structure makes it easier to add (automatically generated) documentation. > I did look at XML_Tree in peardoc 2 and I didn't get this feeling. Almost > every packages are documented in different ways, some have tutorials, others > have only method description, is this normal ? That strongly depends on the person that writes the documentation. > I would like to make doc for the new Config package but it is actually > composed of 2 main classes Config and Config_Container. I thought that if I > look at the way XML_Tree is documented, I could find a template for > documenting Config because there is XML_Tree and XML_Tree_Node. But > XML_Tree_Node is not documented and I couldn't figure out how to insert > Config_Container in peardoc structure. You should probably have a look at how Log and Log_Observer are documented. And further questions should be directed to pear-doc@lists.php.net. > I already wrote a tutorial for HTML_Table a long time ago. I started one > about HTML_QuickForm a few month ago, sent the beginning to Alexander Merz > and never had any feedback. It was actually written directly in docbook. You should send it to pear-doc. - Martin