Re: Online doc generator

On Apr 12, 2004, at 10:15 AM, Jesus M. Castagnetto wrote:

What became of the idea of generating bare documents from the PHPDocumentor tags in the code? I know all packages have those and at least auto-generating them for packages w/o documentation should be somewhat automated. I know it is non-trivial to decide that, so as a first pass there should be a generation for all packages missing documentation. Later when a lead releases a new version he/she should have the option of checking an option to automatically generate the documentation or not.

The last package I documented using PHPDocumentor is Net_SMTP. I received a lot of support from Greg and I am very thankful for that. Still I had to change each of the XML generated files (missed para, missed description, odd directory placement etc). I will try again with PHPDocumentor latest release. That said, you really need some direct help from the package lead unless the pear group can vote for this auto generation. In any case +1 for me. Some documentation is always better then nothing. I could add some examples or help out.

Indeed. But a good number of packages do have those explanations, examples, info in the inline docs, so some sort of automatic generation is feasible, even if it will not be too pretty (btw, I had not tested PHPDocumentor's generation of PEARDOC XML for some time).

The new release candidate looks very promising to me (with XML beautifier and many improvements). Worth a try. Thanks, David Costa