Re: Re: Questions about phpDocumenter standards.
| From: | Greg Beaver | Date: | Sun, 16 Jul 2006 05:37:27 +0000 |
| Subject: | Re: Re: Questions about phpDocumenter standards. | ||
| References: | 1 2 3 4 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-24663@lists.php.net to get a copy of this message | ||
Justin Patrin wrote:
> 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.
What you want is @internal and {@internal}}. @internal is a tag that is
only displayed when "parseprivate" is set to on, and {@internal}} can
contain anything but tags and is displayed when "parseprivate" is on.
Greg