Required tags

Short Descriptions

Short descriptions must be provided for all docblocks. They should be a quick sentence, not the name of the item. Please read the Coding Standard's sample file about how to write good descriptions.

PHP Versions

One of the following must go in the page-level docblock:

  • PHP version 4

  • PHP version 5

  • PHP versions 4 and 5

@license

There are several possible licenses. One of the following must be picked and placed in the page-level and class-level docblocks:

  • @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0

  • @license http://www.freebsd.org/copyright/freebsd-license.html BSD License (2 Clause)

  • @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)

  • @license http://www.freebsd.org/copyright/license.html BSD License (4 Clause)

  • @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

  • @license http://www.php.net/license/3_0.txt PHP License 3.0

For more information, see the PEAR Group's Licensing Announcement: http://pear.php.net/group/docs/20040402-la.php

@link

The following must be used in both the page-level and class-level docblocks. Of course, change "PackageName" to the name of your package. This ensures the generated documentation links back your package.

@link http://pear.php.net/package/PackageName

@author

There's no hard rule to determine when a new code contributor should be added to the list of authors for a given source file. In general, their changes should fall into the "substantial" category (meaning somewhere around 10% to 20% of code changes). Exceptions could be made for rewriting functions or contributing new logic.

Simple code reorganization or bug fixes would not justify the addition of a new individual to the list of authors.

@since

This tag is required when a file or class is added after the package's initial release. Do not use it in an initial release.

@deprecated

This tag is required when a file or class is no longer used but has been left in place for backwards compatibility.

Base docblock (Previous) Optional tags (Next)
Last updated: Sun, 23 Nov 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.