@category – Joomla DocBlock headers

Please note the following:

  • This article is supporting documentation for our tutorial, using DocBlocks in Joomla.
  • There is official documentation that references what headers to use in your DocBlocks (such as @copyright and @license), but documentation is missing that outlines what values to use for each header.
  • In an effort to learn what values to use per each header, we have scanned the Joomla code and pulled out how each header is used. The idea behind this page is to show you how the @category tag has been used in the past within the Joomla code so learn how to use it in your future documentation.

Value Count

The following table shows the various different values for @category, and how many times each value has been used.

Value# Times used
* @category 1

This tag:
* @category
has been used a total of 1 times within the following files:

administrator/components/com_joomlaupdate/restore.php: * @category 

Was this article helpful? Join the conversation!