Syntax

@link [URI] [<description>]

or inline

{@link [URI] [<description>]}

Description

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

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

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

Effects in phpDocumentor

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.

Examples

Normal tag:

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

Inline tag:

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