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

@category

Specify a category to organize the documented element's package into

by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
@category categoryname

Description

The @category tag is used to organize groups of packages together. This is directly applicable to the XML:DocBook/peardoc2 Converter, and can be used by other converters. Other Converters packaged with phpDocumentor ignore the category, but this may change in future versions. It is also possible to dynamically specify category using the -dc, --defaultcategoryname command-line switch.

Example

Here's an example:

  1. /**
  2.  * Page-Level DocBlock
  3.  * @package MyPackage
  4.  * @category mycategory
  5.  */
  6.  
  7. /**
  8.  * @global array used for stuff
  9.  */
  10. function mine()
  11. {
  12.     global $baz;
  13.     ...
  14. }

Prev Up Next
@author phpDocumentor tags @copyright

Documentation generated on Sun, 02 Sep 2012 00:00:36 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.