Re: #20068 [NEW]: PHPDoc short line is confusing
| From: | Martin Jansen | Date: | Fri, 25 Oct 2002 20:55:32 +0000 |
| Subject: | Re: #20068 [NEW]: PHPDoc short line is confusing | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-10257@lists.php.net to get a copy of this message | ||
On Fri Oct 25, 2002 at 04:3245PM +0200, Alexander Merz wrote:
> mattb@columbia.edu wrote:
> >From: mattb@columbia.edu
> >Operating system: GNU/Linux 2.4.18-17.7.x (RedHat)
> >PHP version: 4.2.3
> >PHP Bug Type: PEAR related
> >Bug description: PHPDoc short line is confusing
> >
> >I'm not sure what the intention was with the short vs. long description in
> >PHPDoc, but the implementation seems to cut it off after the first line
> >which yields some interesting documentation (even in PEAR's own classes).
> >For example, take the following comment from PEAR.php:
>
> This is the expected behavoir - it is documented in the original
> PHPDoc-Docs on www.phpdoc.de and for JavaDoc by Sun.
> The idea of the one liner is intended to be rendered in a TOC (like in
> the pear manual) or in a short api summary (like in the phpdoc-html)
Please try to reply via bugs.php.net next time. Thanks ;-).
--
- Martin Martin Jansen
http://martinjansen.com/