Re: future of PEAR

On Tue, 11 Nov 2003 at 11:15:28, Michael Wallner wrote: > Hi Björn Schotte, you wrote: > > > Is there now a 'standard' for documentation? Couldn't see anything > > on the PEAR manual after a quick view. Are there any documentation > > templates that a developer could use? > > Yes there is a standard: Docbook XML, or what are you thinking about > with 'standard' in mind? A kind of templates can be found, too: > http://cvs.php.net/cvs.php/peardoc/en/authoring > > > Provide an "author's SDK", a .tgz or .ZIP with all kinds of > > templates for classes, documentation, perhaps unit tests and a > > skeleton PEAR package, some kind of automatic tools to verify if a > > PEAR package complies to the standards (or complies to the > > standards for PFC etc.). > > I think that's easier to say than to do. How to verify automatically > that a package/class is PEAR compliant than viewing the code > personally - there are as usual many ways to do this right. > > When making docs - I think - it's the easiest way to look how others > have done this before. > Questions about Docbook can be most probably best answered here: > > http://www.oreilly.com/catalog/docbook/chapter/book/docbook.html+ So how would you actually write docs? Use phpDocumentor to generate docbook from the source (phpdoc-comments) and then edit the docbook-files to extend the doc? What if you make changes to the code - then you have to write the docbook- files again and again? Or is there a way to simply "update" them? Sorry, haven't yet figured out how to work with all those "tools" :-(( > I cannot say much about test cases, because PHPEdit generates them in > a "one click" charm. :-) What does it generate? How? I think writing tests also needs some further explanation on this list ... but I will ask about that when the other discussions are threw :-) Regards, Stefan