Re: New header block questions

From: Date: Tue, 29 Mar 2005 03:58:28 +0000
Subject: Re: New header block questions
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-36920@lists.php.net to get a copy of this message
Ian Eure wrote:
I'm looking at moving to the new header blocks for my packages, and I have a few questions about the new blocks. - Can two @version tags exist in the same docblock, one for package version and one for CVS version?
Yes. @version doesn't do anything but display the stuff you pass to it.
- Do I need to have @package & @category duplicated in the page and class blocks, or will putting them in the page-level block suffice?
You need them in both. Why? phpDocumentor is designed to process any project, and some projects put more than one kind of class in the same file. However, if you do decide to omit them, phpDocumentor will assume they are the same as the page, and emit a warning on parsing that it has made an assumption. So, there is the reasoning - it is similar to the reason that we use var $blah; inside class definitions for uninitialized variables - so the parser doesn't make assumptions and emit warnings. Greg

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