Re: Status report: Automated API documentation

On May 2, 2004, at 11:49 AM, David Costa wrote:

On 2 mai 04, at 18:43, Paul M Jones wrote:

On May 2, 2004, at 6:27 AM, Martin Jansen wrote:

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.

It's a hell of a good start, it might even be almost at the finish line as far as API docs are concerned. The only serious nitpick I have is that some of the newer package versions seem not to be there (e.g. Text_Wiki 0.14 is online, but the latest version in /Reference/ is 0.8). It think the formatting could use some tweaking, but then everybody has their own individual ideas of what it should look like. Great work, Martin, good stuff; thank you for getting that out the door. :-)

I agree, this API auto generation is very good and impressive , all is missing is a user guide/examples which can be linked easily and kept on a wiki

And two other wishes, as long as we're wishing: * Maybe a "package-current" version that always has the most-recent documentation (so that external links to 0.1 do not break when 0.2 comes out), and * Maybe a comment system attached to the individual pages. These are not complaints, just future-oriented "it would be nice if"s. The system really is quite good even as it is now. -- Paul M. Jones Savant: the simple alternative to Smarty for PHP. http://phpsavant.com/ DB_Table: build RDBMS tables and XHTML forms in one PHP class. http://wiki.ciaweb.net/yawiki/index.php?area=DB_Table Yawiki: your collaborative online documentation system. http://wiki.ciaweb.net/yawiki/index.php?area=Yawiki