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

Class: parserNameTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserNameTag

Class Overview

This class represents the @name tag

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

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserNameTag
Author(s): Information Tags:
Version:  $Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Tutorial:  @name

Properties

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 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   tag name

[ Top ]
Method Summary
parserNameTag   parserNameTag()  
string   Convert()  

[ Top ]
Properties
string   $keyword = 'name' [line 173]

tag name


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

[ Top ]
Methods
Constructor parserNameTag  [line 179]

  parserNameTag parserNameTag( string $name, string $value  )

Parameters:
string   $name:  not used
string   $value:  name


[ Top ]
Convert  [line 189]

  string Convert( Converter &$c  )

Parameters:
Converter   &$c: 

API Tags:
Return:  converted value of the tag
See:  parserStringWithInlineTags::Convert()


Redefinition of:
parserTag::Convert()

[ Top ]

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