Re: PEAR Descriptions/More documentation

On Mon, 8 Oct 2001 11:39:57 -0400, Chuck Hagenbuch wrote: >Quoting Martin Jansen <mail@martin-jansen.de>: > >> The API documentation is intended for developers, but not for end users >> of the classes. What would you say, if >> http://www.php.net/manual/ would >> be PHP's API documentation :-)? > >The end-users of classes usually _are_ developers. May be. But I know lot's of developers who want to use PEAR code but who are not familiar in reading an API documentation. For them it's easy to have a literal description of what a class does and how to use it. >Now, of course there are cases where you want more documentation. But I >think it's a mistake not to include the api docs somewhere very >prominent. I never meant to exclude the API documentation from the whole documentation project. I think real' documentation and API documentation 'can co-exist. Right now I'm playing a bit with phpdoc and php-gtk-doc to see how they did the stuff. - Martin