Re: Publishing API documentation for each release
| From: | Daniel Convissor | Date: | Tue, 09 Mar 2004 14:54:08 +0000 |
| Subject: | Re: Publishing API documentation for each release | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-2935@lists.php.net to get a copy of this message | ||
Hi Folks:
On Tue, Mar 09, 2004 at 10:33:33AM +0100, Stefan Neufeind wrote:
> On 9 Mar 2004 at 2:50, Daniel Convissor wrote:
>
> > Are you suggesting that the "Intro - *" sections remain as is, but all
> > of the function pages, such as DB::connect(), should come directly
> > from the docblocks?
>
> Surely this would be good.
Aeee. This would be WRETCHED! Let me speak solely of DB, which I know:
* The docblocks are in poor shape and are not 100% accurate.
* There are multiple classes (DB_mysql, DB_pgsql, etc) with the same
method/property names, but they need to be documented only once
under DB_common.
In addition, the output from phpDocumentor, while pretty good, isn't
perfect. So, as a documentation author, it's nice to have complete
control over the formatting of the output by manually editing the .xml
files.
So, if that's really the proposal, a -3 from me.
--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