phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Prev Next

@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...

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.

Caution
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@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);

Prev Up Next
@license phpDocumentor tags @method

Documentation generated on Sun, 02 Sep 2012 00:00:37 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.