Class: parserUsesTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents the "@uses" tag

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.5.0a1

Copyright:

2002-2008 Gregory Beaver

Variables

$keyword

Methods

Child classes:

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

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserSeeTag

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

Class: parserLinkTag

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

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.

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

Class: parserBase

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

Class Details

[line 838]
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 <cellog@php.net>
Version: Release: 1.5.0a1
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

[ Top ]

Class Variables

$keyword = 'uses'

[line 844]

Always "uses"

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserUsesTag (Constructor) [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.

Return: link to the uses target
Todo: CS cleanup - rename to convert for camelCase rule

Overridden in child classes as:

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

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

Parameters:

Converter &$c — the output converter

[ Top ]

getDescription [line 908]

parserStringWithInlineTags getDescription(
)

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

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

[ Top ]