phpDocumentor phpDocumentor
DocBlockTags
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserUsesTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserUsesTag

Class Overview

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

Located in /phpDocumentor/DocBlockTags.inc [line 838]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserSeeTag
               |
               --parserUsesTag
Author(s): Information Tags:
Tutorial:  @uses
Version:  Release: @[email protected]
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

Properties

Methods

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

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserSeeTag

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

Inherited From parserLinkTag

parserLinkTag::parserLinkTag()
sets up the link tag

Inherited From 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 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 parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ Top ]
Property Summary
string   $keyword   Always "uses"

[ Top ]
Method Summary
parserUsesTag   parserUsesTag()   set up the uses tag
string   Convert()   Return a link to documentation for other element, and description of how it is used
parserStringWithInlineTags   getDescription()   Get the description of how the element used is being used.

[ Top ]
Properties
string   $keyword = 'uses' [line 844]

Always "uses"


Redefinition of:
parserSeeTag::$keyword
always 'see'

Redefined in descendants as:

[ Top ]
Methods
Constructor parserUsesTag  [line 857]

  parserUsesTag parserUsesTag( string $seeel, parserStringWithInlineTags $description  )

set up the uses tag

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


[ Top ]
Convert  [line 879]

  string Convert( Converter &$c  )

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.

Parameters:
Converter   &$c:  the output converter

API Tags:
Return:  link to the uses target

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

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

Redefined in descendants as:

[ Top ]
getDescription  [line 908]

  parserStringWithInlineTags getDescription( )

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


API Tags:
Usedby:  phpDocumentor_IntermediateParser::addUses() - used to initialize $uses


[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:16 -0600 by phpDocumentor 1.4.4