#1380 [Opn->Csd]: Suggestion : PHPDOC available from PEAR Documentation
| From: | danielc@php.net | Date: | Tue, 11 May 2004 04:11:09 +0000 |
| Subject: | #1380 [Opn->Csd]: Suggestion : PHPDOC available from PEAR Documentation | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3942@lists.php.net to get a copy of this message | ||
ID: 1380
Updated by: danielc@php.net
Reported By: i at camerongreen dot org
-Status: Open
+Status: Closed
Package: Documentation
Operating System: NA
PHP Version: Irrelevant
New Comment:
This is already in the works. The test version is already online and
the public release should be made shortly. It will have the
phpDocumentor generated documentation for each version of each
package.
Of course, until then, you can read the docblocks in the source code.
Previous Comments:
------------------------------------------------------------------------
[2004-05-10 23:35:20] i at camerongreen dot org
Description:
------------
I think it would be very useful if you would have a link to the
PhpDocumentor documentation for all packages.
The documentation is often in a howto format, for instance I had some
problems using mysqli and sockets (of course it just didn't work and
the latest release has fixed that) and I had to trawl around in the
code to try and figure it out.
It would be much better if, like the java apis at sun, you could access
the list of functions, their parameters etc online. It would also
automate the online documentation of many packages, especially sub
packages like the mysqli interface to the DB package.
Inline documentation is much more likely to be maintained and available
than seperate documentation. I think the seperate documentation is
always useful, but let it stick to extra help and have all the more
minor functions done automatically.
Cheerio,
Cameron
------------------------------------------------------------------------
--
Edit this bug report at http://pear.php.net/bugs/bug.php?id=1380&edit=1