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

Class: parserLicenseTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserLicenseTag

Class Overview

represents "@license"

Link to a license, instead of including lines and lines of license information in every file

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

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

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 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 'license'

[ Top ]
Method Summary
parserLicenseTag   parserLicenseTag()   URL to link to

[ Top ]
Properties
string   $keyword = 'license' [line 528]

always 'license'


Redefinition of:
parserLinkTag::$keyword
always 'link'

[ Top ]
Methods
Constructor parserLicenseTag  [line 534]

  parserLicenseTag parserLicenseTag( $name, string $link  )

URL to link to

Parameters:
string   $link: 
   $name: 


[ Top ]

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