Re: PEAR Descriptions/More documentation

From: Date: Mon, 08 Oct 2001 17:05:38 +0000
Subject: Re: PEAR Descriptions/More documentation
References: 1  Groups: php.pear.general 
Request: Send a blank email to pear-general+get-378@lists.php.net to get a copy of this message
> >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. if every class is properly documented in source and the class header includes (at least should) some information that says what the class does i think there is literal description if this is the case the only thing missing would be an example, i think and the names of classes/directories in PEAR do at least tell me very well what i have to expect from this class(es) Wolfram

« previous php.pear.general (#378) next »