Re: PHPod documentation
| From: | (Oleg Rekutin) | Date: | Tue, 31 Jul 2001 17:39:48 +0000 |
| Subject: | Re: PHPod documentation | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1197@lists.php.net to get a copy of this message | ||
jcastagnetto@yahoo.com (Jesus M. Castagnetto) wrote in
news:20010731173018.47283.qmail@web12107.mail.yahoo.com:
> My 2 cents:
>
> I do not see the problem on putting descripitons and examples of usage
> in the javadoc-style that is phpdoc. Javadoc itself allows to put
> markup that indicates formatting if that is what you need, by allowing
> the use of HTML in the comment section of the documentation, see:
>
> http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
>
> (in particular the example on documentation at the end of the page)
>
> WIth that in mind, I do not see the advantage of a POD style
> documentation system, unless someone has a more compelling reason than
> just a formatting capability.
I quite agree! If you look over Java API docs, you'll see enough examples
and what not, using embedded HTML. It wouldn't be so hard to adjust phpdoc
to convert HTML markup to plain text format, if the need be.
I say improve upon phpdoc (such as clearly state every possible tag and its
syntax) and forget about POD.
- Oleg