Re: Publishing API documentation for each release
| From: | Daniel Convissor | Date: | Tue, 09 Mar 2004 07:50:56 +0000 |
| Subject: | Re: Publishing API documentation for each release | ||
| References: | 1 2 3 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-2933@lists.php.net to get a copy of this message | ||
Hi Martin (et al):
On Tue, Mar 09, 2004 at 08:20:44AM +0100, Martin Jansen wrote:
>
> That is not entirely correct: There will still be documentation for
> packages in the PEAR manual, but it will nto contain API documentation
> anymore: The manual will provide examples, usage tutorials etc., but the
> documentation that can be generated with phpDocumentor will be provided
> externally.
Hmm... Maybe I'm misunderstanding your proposal. So, to clarify, let's
use DB, http://pear.php.net/manual/en/package.database.php,
as an example.
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?
Thanks,
--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