Re: #20068 [NEW]: PHPDoc short line is confusing

From: Date: Fri, 25 Oct 2002 14:32:45 +0000
Subject: Re: #20068 [NEW]: PHPDoc short line is confusing
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-10252@lists.php.net to get a copy of this message
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) That a lot of PEAR-Programmers do not run phpdoc over their own code, and never see the warnings and missing/wrong docs. This is sad, but reality.

« previous php.pear.dev (#10252) next »