Re: RE: [PEAR-DOC] Re: [PEAR-DEV] looking for volunteers phpDocumentor, new converter reST
| From: | Analysis & Solutions | Date: | Fri, 13 Jun 2003 23:36:29 +0000 |
| Subject: | Re: RE: [PEAR-DOC] Re: [PEAR-DEV] looking for volunteers phpDocumentor, new converter reST | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-17432@lists.php.net to get a copy of this message | ||
Folks:
On Fri, Jun 13, 2003 at 05:01:01PM -0400, Jon Parise wrote:
>
> One of the major advantages to using a simple format like reST is the
> removal of the requirement that the documentation be "rendering" in
> order for it to be readable. In other words, it's entirely possible
> to author completely readable reST documents without ever rendering
> them using docutils.
Perhaps I'm misunderstanding the discussion. Is the thread about the
format used for the documentation used in the backend of PEAR -- to
generate things like the PEAR website? Or, is it about a new
standard for inline docblock comments in PEAR code and packages?
If we're talking about the latter, I think switching formats is a big
mistake. A huge amount of time has gone into writing phpdoc/phpDocumentor
style comments. Plus there's the massive investment in writing
phpDocumentor itself -- bless you Greg, Joshua, et al!
As far as your point about the readability of unrendered documentation,
phpDocumentor syntax is very readable. If you're thinking of docbook,
then I've got to agree!
Enjoy,
--Dan
--
FREE scripts that make web and database programming easier
http://www.analysisandsolutions.com/software/
T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y
4015 7th Ave #4AJ, Brooklyn NY v: 718-854-0335 f: 718-854-0409