5.12. @link

The @link tag indicates a custom relation between associated Structural Elements and a website, which is identified by an absolute URI.

5.12.1. Syntax

@link [URI] [description]

or inline

{@link [URI] [description]}

5.12.2. Description

The @link tag can be used to define a relation, or link, between Structural Elements, or part of the long description when used inline, to an URI.

The URI MUST be complete and well-formed as specified in RFC2396.

The @link tag MAY have a description appended to indicate the type of relation defined by this occurrence.

5.12.3. Effects in DocBlox

Structural Elements, or inline text in a long description, tagged with the @link tag will show a link in their description. If a description is provided with the tag then this will be used as link text instead of the URL itself.

5.12.4. Examples

Normal tag:

 /**
  * @link http://example.com/my/bar Documentation of Foo.
  *
  * @return integer Indicates the number of items.
  */
 function count()
 {
     <...>
 }

Inline tag:

 /**
  * This method counts the occurrences of Foo.
  *
  * When no more Foo ({@link http://example.com/my/bar}) are given this
  * function will add one as there must always be one Foo.
  *
  * @return integer Indicates the number of items.
  */
 function count()
 {
     <...>
 }