Re: PEAR Descriptions/More documentation
| From: | Chuck Hagenbuch | Date: | Mon, 08 Oct 2001 15:39:57 +0000 |
| Subject: | Re: PEAR Descriptions/More documentation | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-375@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. PHP's API documentation is
useful to those using PHP's API to write php functions... The API documentation
of a class is useful to people using that class to build systems. I.e., end
users.
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've found
that Sun's API docs (javadoc) are usually _far_ more useful than the other docs
they post with their frameworks.
-chuck
--
Charles Hagenbuch, <chuck@horde.org>
"What was and what may be lie, like children whose faces we cannot see, in the
arms of silence. All we ever have is here, now." - Ursula K. Le Guin