Re: Online doc generator

--- David Costa <gurugeek@php.net> wrote: [... big snip ...] > For the current I plan to link (as suggested by Martin) the existing > external documentation to the manual. In this way the user can see the > docs, even if hosted > by the package lead. Is not a final solution but can help. > > For the future we do need to ask some documentation to be available in > the external site, pear manual or just somewhere. 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. For telling the leads that documentation will be autogenerated for them (using PHPDocumentor, so they have a starting point), there could bug reports submitted for the appropriate packages, assuming that the problem with the bug system not sending emails to the leads when a new bug is submitted is fixed (yes, I did submit a bug report on that :-) > I second your view on "the real problem are missing author" but > comments to generate some documentation are required by the coding > standards. > Furthermore my distinction on the writer/non writer is different. You > don't need to be a writer to document your own package. If the package > lead can't explain what > your package does to someone else, then this is a problem. 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). ===== -- Jesus M. Castagnetto (jcastagnetto@yahoo.com) Research: http://metallo.scripps.edu/ Personal: http://www.castagnetto.org/ PEAR stuff: http://pear.php.net/user/jmcastagnetto __________________________________ Do you Yahoo!? Yahoo! Tax Center - File online by April 15th http://taxes.yahoo.com/filing.html