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

Class: parserIdInlineTag

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

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Represents the inline {@id} tag for tutorials


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods

Class: parserInlineTag

parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag::getString()
always gets an empty string
parserInlineTag::Strlen()
get length of the tag

Class: parserBase

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

Class Details

[line 835]
Represents the inline {@id} tag for tutorials


[ Top ]


Class Variables

$category =  'default'

[line 851]

category of the {@id}

Type:   string


[ Top ]

$id =

[line 866]

section/subsection name

Type:   string


[ Top ]

$inlinetype =  'id'

[line 841]

always 'id'

Type:   string
Overrides:   Array


[ Top ]

$package =  'default'

[line 846]

package of the {@id}

Type:   string


[ Top ]

$subpackage =  ''

[line 856]

subpackage of the {@id}

Type:   string


[ Top ]

$tutorial =

[line 861]

full name of the tutorial

Type:   string


[ Top ]



Method Detail

parserIdInlineTag (Constructor)   [line 877]

parserIdInlineTag parserIdInlineTag( string $category, string $package, string $subpackage, string $tutorial, [string $id = false])

constructor

Parameters:

string   $category     category name
string   $package     package name
string   $subpackage     subpackage name
string   $tutorial     tutorial name
string   $id     section/subsection name

[ Top ]

Convert   [line 895]

string Convert( Converter &$c)

converter

Parameters:

Converter   &$c     output converter

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:01:59 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.