@version

The @version tag indicates the current version of Structural Elements.

Syntax

@version [<vector>] [<description>]

Description

The @version tag can be used to indicate the current version of Structural Elements.

This information can be used to generate a set of API Documentation where the consumer is informed about elements at a particular version.

It is RECOMMENDED that the version number matches a semantic version number as described in the Semantic Versioning Standard version 2.0 at http://www.semver.org.

Version vectors from Version Control Systems are also supported, though they MUST follow the form:

name-of-vcs: $vector$

A description MAY be provided, for the purpose of communicating any additional version-specific information.

Effects in phpDocumentor

phpDocumentor shows the version information with the documented element.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 /**
  * @version 1.0.1
  */
 class Counter
 {
     <...>
 }

 /**
  * @version GIT: $Id$ In development. Very unstable.
  */
 class NeoCounter
 {
     <...>
 }

Templates