Docs For Class parserUsedByTag

Description

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

This is exactly like @uses.

author: Greg Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
todo: CS cleanup - change classname to PhpDocumentor_*
since: 1.2
license: LGPL

Located in /phpDocumentor/DocBlockTags.inc (line 932)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserSeeTag
               |
               --parserUsesTag
                  |
                  --parserUsedByTag

Variable Summary

string $keyword

Method Summary

parserUsedByTag parserUsedByTag (abstractLink $link, string $description)

string Convert (Converter &$c)

Variables

string $keyword = 'usedby' (line 938)

Always "usedby"

Redefinition of:

parserUsesTag::$keyword: Always "uses"

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserUsedByTag (line 950)

set up the usedby tag

parserUsedByTag parserUsedByTag (abstractLink $link, string $description)

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

Convert (line 964)

process this tag through the given output converter

todo: CS cleanup - rename to convert for camelCase rule

string Convert (Converter &$c)

Converter &$c: the output converter

Redefinition of:

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

Inherited Methods

Inherited From parserUsesTag

parserUsesTag::parserUsesTag()
parserUsesTag::Convert()
parserUsesTag::getDescription()

Inherited From parserSeeTag

parserSeeTag::parserSeeTag()
parserSeeTag::Convert()

Inherited From parserLinkTag

parserLinkTag::parserLinkTag()

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()