Class parserUsedByTag

(line 932)



Located in File: /phpDocumentor/

This is a virtual tag, it is created by @uses to cross-reference the used element

This is exactly like @uses.

Class Variables

string $keyword

$keyword = 'usedby' (line 938)

Data type : string

Overrides: Array

Always "usedby"

Class Constants


Method Detail

parserUsedByTag parserUsedByTag (abstractLink $link, string $description)
string Convert (Converter &$c)

Constructor parserUsedByTag (line 950)

parserUsedByTag parserUsedByTag( abstractLink $link, string $description)

set up the usedby tag


  • abstractLink $link: link of element that uses this element
  • string $description: description of how the element is used


Method Convert (line 964)

string Convert( Converter &$c)

Overrides : parserUsesTag::Convert() Return a link to documentation for other element, and description of how it is used

process this tag through the given output converter



  • todo - CS cleanup - rename to convert for camelCase rule

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserUsesTag

parserUsesTag::parserUsesTag() - set up the uses tag

parserUsesTag::Convert() - Return a link to documentation for other element, and description of how it is used

parserUsesTag::getDescription() - Get the description of how the element used is being used.

Inherited From Class parserSeeTag

parserSeeTag::parserSeeTag() - sets up the see tag

parserSeeTag::Convert() - process this tag through the given output converter

Inherited From Class parserLinkTag

parserLinkTag::parserLinkTag() - sets up the link tag

Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

parserTag::Convert() - Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::add() - equivalent to the . operator ($a = $b . $c)

parserStringWithInlineTags::Convert() - Use to convert the string to a real string with all inline tags parsed and linked

parserStringWithInlineTags::getString() - return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)

parserStringWithInlineTags::hasInlineTag() - Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource() - Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen() - equivalent to trim(strlen($string))

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value

Documentation generated on Mon, 05 Dec 2011 21:26:22 -0600 by phpDocumentor 1.4.4