Re: Status report: Automated API documentation
| From: | Martin Jansen | Date: | Mon, 03 May 2004 07:53:27 +0000 |
| Subject: | Re: Status report: Automated API documentation | ||
| References: | 1 2 3 4 5 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3871@lists.php.net to get a copy of this message | ||
On Sun May 02, 2004 at 06:4345PM -0400, Daniel Convissor wrote:
> 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.
Alternatively we might associate the comments with the packages and make
them available via the package homepage *and* the corresponding manual
section.
> Creating and maintaining a comments system is a lot of
> work.
Initially creating a comments system isn't that much work, but I think
that maintaining the comments, deleting spam and FUD, etc. may quickly
turn out to be a nightmare.
--
- Martin Martin Jansen
http://martinjansen.com/