Class: parserUsedByTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserUsedByTag

Class Overview

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

This is exactly like @uses.

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

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Since:	1.2

Properties

$keyword

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserUsesTag

parserUsesTag::parserUsesTag()

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 parserSeeTag

parserSeeTag::parserSeeTag()

parserSeeTag::Convert()

Inherited From parserLinkTag

parserLinkTag::parserLinkTag()

URL to link to

Inherited From parserTag

parserTag::parserTag()

Set up the tag

parserTag::Convert()

parserTag::getString()

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

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

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string

$keyword

Always "usedby"

[ Top ]

Method Summary

parserUsedByTag	parserUsedByTag()
string	Convert()

[ Top ]

Properties

string $keyword = 'usedby' [line 635]

Always "usedby"

Redefinition of:

parserUsesTag::$keyword: Always "uses"

[ Top ]

Methods

Constructor parserUsedByTag [line 643]

parserUsedByTag parserUsedByTag(
abstractLink
$link, string
$description 
)

Parameters:

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

[ Top ]

Convert [line 653]

string Convert(
Converter
&$c 
)

Parameters:

Converter

&$c:

Redefinition of:

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

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:22 -0500 by phpDocumentor 1.3.1

	phpDocumentor DocBlockTags

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