[PEPr] Comment on RFC::Header Comment Blocks
| From: | Ian Eure | Date: | Thu, 27 Jan 2005 23:47:19 +0000 |
| Subject: | [PEPr] Comment on RFC::Header Comment Blocks | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-35740@lists.php.net to get a copy of this message | ||
Ian Eure (http://pear.php.net/user/ieure) has commented on the proposal for RFC::Header Comment
Blocks.
Comment:
>> The page-level docblock seems redundant
>> for files which only contain a single
>> class.
> phpDocumentor produces separate > pages for each file and for each >
class. Thus, both docblocks are needed > to produce complete
documentation.
Right, but what is that page-level block going to contain? 'This is the
file that contains the FooBar_Baz class, part of the FooBar package.'?
The actual info there is what seems unnecessary and redundant, regardless
of how phpDocumentor handles it.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=128
--
Sent by PEPr, the automatic proposal system at http://pear.php.net