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

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

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

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

Prev Up Next
@license phpDocumentor tags @name

Documentation generated on Tue, 24 Oct 2006 09:20:07 -0500 by phpDocumentor 1.3.1