Re: Re: Questions about phpDocumenter standards.

On 7/14/06, Thomas Anderson <zelnaga@gmail.com> wrote:

On 7/12/06, Greg Beaver <cellog@php.net> wrote: /** * <describe the file here and what it contains> * * PHP version 5 (or PHP version 4 and 5) * * useful resources are as follows: * * - {@link http://www.domain.tld/path/to/pagea Title of webpage A} * - {@link http://www.domain.tld/path/to/page Title of webpage B} * * Some Project's ClassName classes: * see /path/to/file in filename.zip * * * ideas for optimization * * * blah blah blah * * blah blah blah * * blah blah blah * @author you <you@php.net> * @license http://link.to.license whatever * @version $Id$ * @copyright * @see http://www.domain.tld/path/to/PAGE2 PAGE2chapter.subchapter.section */ Another question, heh. My interpretation of @private is that comments intended for developers ought to have it. ie. some comments are going to be of interest to general users and others are going to be of interest to would-be developers.

No, it means that it's a private function/class/member var.

If that's correct, then what about the above optimization ideas? Those would appeal more to developers than they would to end-users but as far as I know, you can't designate parts of a code block private - you have to designate the whole thing or no part of it at all. I tried placing a code block after the main code block but that second code block didn't get parsed at all. Any ideas? On a different note... the sample email address in your example is you@php.net. Does everyone who gets a package in PEAR get a you@php.netemail address?

As long as you use the PHP CVS system, yes. -- Justin Patrin