Docs For Class parserNameTag

Description

This class represents the @name tag

tutorial: @name
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_*
license: LGPL

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

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserNameTag

Variable Summary

string $keyword

Method Summary

parserNameTag parserNameTag (string $name, string $value)

string Convert (Converter &$c)

Variables

string $keyword = 'name' (line 209)

tag name

Redefinition of:

parserTag::$keyword: tag name (see, access, etc.)

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserNameTag (line 217)

set up the name tag

parserNameTag parserNameTag (string $name, string $value)

string $name: tag name (not used)
string $value: tag value

Convert (line 231)

process this tag through the given output converter

return: converted value of the tag
see: parserStringWithInlineTags::Convert()
todo: CS cleanup - rename to convert for camelCase rule

string Convert (Converter &$c)

Converter &$c: output converter

Redefinition of:

parserTag::Convert(): Perform the output conversion on this parserTag using the output converter that is passed in

Inherited Methods

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