Re: about Docs..

On Sat, 3 Nov 2001 21:55:42 +0000 (GMT), Philip Olson wrote: >Regarding the docs, I notice that pear.php.net/manual is very >similar to php.net/manual/en/pear.php What's the semi-final >word, will the manual be on www.php.net or pear.php.net ? Once it is finished, it will be on http://pear.php.net/manual/. Currently there are some plans to also include the basic documentation ("What is PEAR" etc.) also in the PHP Manual. >I'm editing pear in phpdoc right now and am wondering if I >should be. PEAR has to ways of documentation: The first way is the API documentation with PHPDoc. The second way is the documentation with Docbook. The API documentation is for programmers, that are interested in how your code works, how to extend it. etc. The Docbook documentation is the user manual for PEAR. You can compare it to the PHP documentation: Ususally people don't want to read the API documentation of Zend, when they want to know how they have to use getimagesize(). The other way around, if one wants to build his one extension for PHP, he will surely not want to know how parameters getimagesize() works. To sum it up: You are doing good in using PHPDoc in your code. But as a consequence, you should also use Docbook to write userland documentation for your class. - Martin