Re: Re: Questions about phpDocumenter standards.

On 7/16/06, Greg Beaver <greg@chiaraquartet.net> wrote:

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.

Two questions. Say I have a file test.php with the following contents: <?php /** * Test * * Description * * {@internal To access the company guidelines on modifying this class, * see {@link http://www.example.com Company Guidelines}, or contact * your supervisor}} * Using this class can be very helpful for several reasons. etc. etc. * * @category A

* @package    B

* */ ?> The @internal stuff doesn't appear when I don't want it to, but I can't seem to make it appear when I want it to, either. Here's the command line argument I used: c:\path\to\phpdoc -o HTML:frames:earthli -f test.php -t test --parseprivate c:\path\to\phpdoc -o HTML:frames:earthli -f test.php -t test -pp Neither worked. You also say that @internal doesn't work with tags, yet the following does seem to be hidden by them, none-the-less: <?php /** * Test * * Description * * {@internal To access the company guidelines on modifying this class, * see {@link http://www.example.com Company Guidelines}, or contact * your supervisor * * <ul><li>test</li><li>test</li></ul>}} * Using this class can be very helpful for several reasons. etc. etc. * * @category A

* @package    B

* */ ?> * <ul><li>test</li><li>test</li></ul>