Status report: Automated API documentation
| From: | Martin Jansen | Date: | Sun, 02 May 2004 11:27:25 +0000 |
| Subject: | Status report: Automated API documentation | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-28694@lists.php.net to get a copy of this message | ||
As you might have noticed from my commits yesterday, the infrastructure
for automatically generating API documentation for new releases is in
place now.
In the next days, the API documentation will also be linked on the
package homepages (http://pear.php.net/package/<package>/). For now you
can have a look at the already existing documentation at
http://pear.php.net/reference/
(Long list, so it may take some time to load. Additionally /reference/
is likely not the final URL.)
The fonts are a bit too small at the moment, but this will be changed
soon.
I'd be happy if the folks, who will attend to the developers meeting
tomorrow, take the disposability of the API documentation into account
when discussing about future directions of the PEAR documentation: The
automatically generated documentation will of course not replace
documentation that is targeted at end-users, but I believe that it is a
good start.
If you would like to write a followup to this mail, please make sure
that the mail goes to pear-doc and _not_ to pear-dev.
--
- Martin Martin Jansen
http://martinjansen.com/