Re: Questions about phpDocumenter standards.

From: Date: Tue, 18 Jul 2006 18:12:01 +0000
Subject: Re: Questions about phpDocumenter standards.
References: 1 2 3  Groups: php.pear.general 
Request: Send a blank email to pear-general+get-24692@lists.php.net to get a copy of this message
If I only have one class in my file, aren't the short and long descriptions for the file going to be the same as they are for the class? If so, it seems kinda redundant. If not, what am I not understanding? Also, when should the non-line @internal be used instead of @private? Both appear when the -parseprivate command line option is used and since functions can, as I understand, only have one docblock per function, there's not a whole lot of point to using both. @private means that the function isn't supposed to publically accessable. If a function is marked as @internal, doesn't it also mean that that function isn't supposed to be publically accessable? Why else would one lable it private? Now, @private functions can be overwridden, unless they're declared as @final. Are @internal functions supposed to be both @private and @final? Additionally, one of the examples from the phpDocumentor has the following: /**#@+ * Constants */ What does this mean? It appears to mean that it applies to every line until there's a blank line but I'm not really sure how definitive that is. I don't see this syntax mentioned in the phpDocumentor documentation. Finally, why can't the docblocks for constants be declared @internal or @private? What if the constants are only used by @private or @internal functions? Or should constants not, per the PEAR standards, be used in those functions? Personally, I think they ought to, lest someone trying to understand the private code have a harder time (eg. what does this 3 mean when a constant could have told you, instantly).

« previous php.pear.general (#24692) next »