phpDocumentor Manual
Prev Next

inline {@link}

(phpDocumentor 0.1+ )

inline {@link} --  display a hyperlink or link to an element's documentation in the the flow of descriptive text

Description

{@link URL [description]} -or- {@link @see-style element link [description]}

You may use the inline{@link} tag to document any element (page, global variable, include, class, function, define, method, variable)

Caution

inline {@link} displays links directly in the natural text flow of a DocBlock. If you want to display links prominently after descriptive text, use @see or @link

For parameter information, see @see or @link.

The inline {@link} differs from all ordinary tags. Inline tags parse and display their output directly in the documentation. In other words, this DocBlock:

/**
* Text with a normal @see and @link tag
* @see element
* @link http://www.example.com
*/
function element()
{
}

Parses as:

element

element ( )

Text with a normal @see and @link tag
Function Parameters:
Function Info:
See - element()
Link - www.example.com
 
/**
* Text with an {@link http://www.example.com Inline Link to a Hyperlink} and an inline link to {@link element} displays
* without a break in the flow
*/
function element()
{
}

Parses as:

element

element ( )

Text with an Inline Link to a Hyperlink and an inline link to element() displays without a break in the flow
Function Parameters:
Function Info:
Prev Home Next
@see Up Templates

Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver