Version 18 by Maks 3w
on Nov 09, 2012 17:59.

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (4)

View Page History
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Magic
*/
{code}

The {{@category}} annotation *MUST* have a value of "Zend".

The {{@package}} annotation *MUST* be assigned, and should be equivalent to the component name of the class contained in the file; typically, this will only have two segments, the "Zend" prefix, and the component name. Segments *MUST* be separated by the underscore ("_") character.

The {{@subpackage}} annotation is optional. If provided, it *SHOULD* be the subcomponent name, minus the class prefix. In the example above, the assumption is that the class in the file is either "Zend\Magic\Wand", or lives under that namespace.

h4. Classes

*
* Long description for class (if any)...
*
* @category Zend
* @package Zend_Magic
* @subpackage Wand
*/
{code}

The {{@category}} annotation *MUST* have a value of "Zend".

The {{@package}} annotation *MUST* be assigned, and should be equivalent to the component to which the class belongs; typically, this will only have two segments, the "Zend" prefix, and the component name. Segments *MUST* be separated by the underscore ("_") character.

The {{@subpackage}} annotation is optional. If provided, it *SHOULD* be the subcomponent name, minus the class prefix. In the example above, the assumption is that the class described is either "Zend\Magic\Wand", or lives under that namespace.

h4. Functions