Re: Status report: Automated API documentation
| From: | Daniel Convissor | Date: | Sun, 02 May 2004 22:43:45 +0000 |
| Subject: | Re: Status report: Automated API documentation | ||
| References: | 1 2 3 4 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3866@lists.php.net to get a copy of this message | ||
Folks:
On Sun, May 02, 2004 at 11:57:40AM -0500, Paul M Jones wrote:
>
> * Maybe a comment system attached to the individual pages.
The comments should be a part of the real manual, not the API
documentation. Creating and maintaining a comments system is a lot of
work. Also, comments could get lost in there, not showing up where
they're really needed: the real docs. Also, which version would the
comments be associated with? All versions? Then comments will become
outdated. Etc...
--Dan
--
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
data intensive web and database programming
http://www.AnalysisAndSolutions.com/
4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409