Re: Converting HTML to Docbook
| From: | Martin Jansen | Date: | Sat, 27 Jul 2002 08:35:13 +0000 |
| Subject: | Re: Converting HTML to Docbook | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-8045@lists.php.net to get a copy of this message | ||
On Sat Jul 27, 2002 at 04:1327PM +0800, Alan Knowles wrote:
> /*
> * @Docbook
> * PACKAGESECTION: packages.php.codedoc
> * PAGE: INDEX
> * This chapter expains how to use the phpcodedoc tool which can generate
> lxr type html and docbook
> * output from comments embedded in class files
> *
> * PAGE: Introduction
> * PAGESUMMARY: what is PHP_CodeDoc all about?
> *
> * SECTION: Introduction
> *
> * PHP_CodeDoc was written for a number of reasons
> * LIST:
> * - To make use of the php tokenizer module to generate documentation
> * - To produce documentation that showed the source code as well as
> the notes
> * - Because I saw the ruby class documentation, and thought it looked
> very clear..
> * ENDLIST:
Honestly, don't you think that this makes the API documentation very
hard to read? Most time when debugging/developing code I don't use the
nice HTML output of PHPDoc but the inline comments in the PHP
code to understand how the code works. Your new style IMO makes it a
magnitude harder to read and understand the documentation ;-).
--
- Martin Martin Jansen
http://martinjansen.com/