Previous | Up | Next |
@license | phpDocumentor tags | @method |
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.
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.
Here's an example:
Previous | Up | Next |
@license | phpDocumentor tags | @method |
Documentation generated on Mon, 05 Dec 2011 21:18:37 -0600 by phpDocumentor 1.4.4