Re: Publishing API documentation for each release

On 9 Mar 2004 at 2:50, Daniel Convissor wrote: > 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? Surely this would be good. But if I understand correctly Martin wants to have the Intro as is and the function-descriptions will be available on a separate page. I don't know what this confusing way to do it would be good for. And why wouldn't people also want to include the introduction also using phpDocumentor? That would be the easiest way. All in all, the only way would be to move all package docs completely from the manual into your new phpDocumentor-autogenerated section, only FAQ etc. will be left as is. Martin, why didn't you propose to make the whole API completely in HTML because it can easily be edited using FrontPage :-)) Don't get me wrong - but sorry, but I didn't get the intention maybe. Stefan