Re: Status report: Automated API documentation

From: Date: Sun, 02 May 2004 12:11:44 +0000
Subject: Re: Status report: Automated API documentation
References: 1  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3833@lists.php.net to get a copy of this message
Terrific Martin!! Very impressive. Whilst it does not replace the end user documentation it is a great start for a minimal documentation on every package. Just one question, I have seen one of my packages (Numbers_Roman) referring to the old API and not to the latest version, is it something normal or ? Thanks a lot for the great work, Cheers David Costa On 2 mai 04, at 13:27, Martin Jansen wrote:
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/
-- PEAR Documentation List Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php


« previous php.pear.doc (#3833) next »