@link
Display a hyperlink to a URL in the documentation
by Gregory Beaver
Tag Documentation written by cellog@php.net
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)
| Caution | | @link assumes the arguments passed are fully-formed URLs. If you want to link to an element's documentation, use @see or inline {@link} |
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.
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 */
Documentation generated on Mon, 25 Jun 2007 14:00:52 -0400 by phpDocumentor 1.3.2. PEAR Logo Copyright © PHP Group 2004.
|
|
