phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Prev Next

@ignore

Prevent documentation of an element

by Gregory Beaver
Tag Documentation written by cellog@users.sourceforge.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.0+)
@ignore

Description

Use @ignore to prevent phpDocumentor from documenting an element, such as a duplicate element.

Example

Here is an example of how to use @ignore:


1 if ($ostest)
2 {
3 /**
4 * This define will either be 'Unix' or 'Windows'
5 */
6 define("OS","Unix");
7 } else
8 {
9 /**
10 * @ignore
11 */
12 define("OS","Windows");
13 }

Prev Up Next
@global phpDocumentor tags @internal

Documentation generated on Fri, 30 Apr 2004 22:07:57 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.