Re: Documentation Suggestion

On Wednesday, September 10, 2003 7:47, Alexey Borzov wrote: > Hi! > Tomas V.V.Cox wrote: >> [OFFTOPIC sorry] >> >> Is it possible to create a tool that once you have the code it'd >> parse the .php files and fill the API Doc squeleton? > This tool exists and is called (surprise) phpDocumentor. Maybe I didn't express my self clearly, I'm talking about a tool that create the PHPDoc skeleton comments for your uncommented source code. Can phpDocumentor do that? >> In the other hands, most developers won't write doc if the doc should >> be written in DocBook. Even me would write doc with a lazydoc tool. > After having done docs for HTML_Template_Sigma, (part of) HTML_QuickForm, > HTML_QuickForm_Controller I came to the conclusion that this argument is being > used as an excuse to not write any docs at all. > 1) Current phpDocumentor generates valid DocBook. While I had to fix its output > some time ago, now it is possible to build it without any problems. Thanks, Greg! > 2) Once you have phpDocumentor-generated skeleton, it is fairly easy to add > stuff to it. http://www.docbook.org has a good reference, and > you don't really > need arcane markup to do a *tutorial*. > 3) While building the doc takes some time, it is a matter of minutes on a fast box. > Please note, that I had no experience with DocBook before, and it didn't take > much time to learn it. I do know DocBook, maybe you missed my name at the Pear Manuals editors list. My point is about the usability and the time it makes one waste. -- Tomas V.V.Cox mailto:cox@idecnet.com