Description

You may use the @link tag to document any element (include, page, class, function, define, method, variable). The guidelines for giving the element name to @link are the same as outlined in the @see manual page.

URL is any valid Uniform Resource Locator (http://www.example.com, telnet://example.com, ftp://ftp.example.com, mailto:email@example.com, etc.)

Note that as of version 1.2.0, it is possible to specify a short description for the link to use as the link text instead of the URL.

Example

Here's an example:

1. /**
2.  * Displays <a href="http://www.example.com">http://www.example.com</a>
3.  * @link http://www.example.com
4.  */
5. define("TEST_CONSTANT",3);
6. /**
7.  * Displays <a href="http://www.example.com">Hello</a>
8.  * @link http://www.example.com Hello
9.  */
10. define("TEST_CONSTANT2",3);
11. /**
12.  * You SHOULD use @see here instead of @link, but here's how it works:
13.  * displays <a href="./MyDocs/MyPackage/MyClass.html">MyClass</a>
14.  * @link MyClass
15.  */
16. define("TEST_CONSTANT3",3);