@link
Display a hyperlink to a URL in the documentation
by Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@link
URL
link text
@link
URL, URL, URL...
DescriptionYou 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.
Unless linking to an element, @link assumes the arguments passed are fully-formed URLs. Generally speaking, if you want to link to an element's documentation, use @see or inline {@link}... you can use @link, but the other options are better.
URL is any valid Uniform Resource Locator (http://www.example.com, telnet://example.com, ftp://ftp.example.com, mailto:[email protected], 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.
ExampleHere's an example:
/**
* Displays <a href="http://www.example.com">http://www.example.com</a>
* @link http://www.example.com
*/
/**
* Displays <a href="http://www.example.com">Hello</a>
* @link http://www.example.com Hello
*/
/**
* You SHOULD use @see here instead of @link, but here's how it works:
* displays <a href="./MyDocs/MyPackage/MyClass.html">MyClass</a>
* @link MyClass
*/
|
|