5.3. @category

The @category tag is used to organize groups of packages together but is deprecated in favour of occupying the top-level with the @package tag. As such usage of this tag is NOT RECOMMENDED.

5.3.1. Syntax

@category [description]

5.3.2. Description

The @category tag was meant in the original de-facto Standard to group several Structural Elements their @package tags into one category. These categories could then be used to aid in the generation of API documentation.

This was necessary since the @package tag, as defined in the original Standard, did not contain more then one hierarchy level; since this has changed this tag SHOULD NOT be used.

Please see the documentation for @package for details of its usage.

This tag MUST NOT occur more than once in a DocBlock.

5.3.3. Effects in DocBlox

The @category tag has no significant effect in DocBlox. It will be shown with the description information of associated Structural Elements and is inherited by classes and interfaces.

5.3.4. Examples

 /**
  * Page-Level DocBlock
  *
  * @category MyCategory
  * @package  MyPackage
  */