Docs For Class parserUsesTag

Description

represents the "@uses" tag

This is exactly like @see except that the element used has a @useby link to this element added to its docblock

tutorial: @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 838)

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

Direct descendents

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

Variable Summary

string $keyword

Method Summary

parserUsesTag parserUsesTag (string $seeel, parserStringWithInlineTags $description)

string Convert (Converter &$c)

parserStringWithInlineTags getDescription ()

Variables

string $keyword = 'uses' (line 844)

Always "uses"

Redefinition of:

parserSeeTag::$keyword: always 'see'

Redefined in descendants as:

parserUsedByTag::$keyword : Always "usedby"

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserUsesTag (line 857)

set up the uses tag

parserUsesTag parserUsesTag (string $seeel, parserStringWithInlineTags $description)

string $seeel: element to link to
parserStringWithInlineTags $description: description of how the element is used

Convert (line 879)

Return a link to documentation for other element, and description of how it is used

Works exactly like parent::Convert() except that it also includes a description of how the element used is used.

return: link to the uses target
todo: CS cleanup - rename to convert for camelCase rule

string Convert (Converter &$c)

Converter &$c: the output converter

Redefinition of:

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

Redefined in descendants as:

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

getDescription (line 908)

Get the description of how the element used is being used.

usedby: phpDocumentor_IntermediateParser::addUses() - used to initialize $uses

parserStringWithInlineTags getDescription ()

Inherited Methods

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