Class: parserLicenseTag

Source Location: /PEAR/PhpDocumentor/phpDocumentor/DocBlockTags.inc

Class parserLicenseTag

Class Overview

represents the "@see" tag

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

Located in /PEAR/PhpDocumentor/phpDocumentor/DocBlockTags.inc [line 787]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserLicenseTag

Author(s):

Greg Beaver <cellog@php.net>

Information Tags:

Tutorial:	@license
Version:	Release: 1.4.2
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

Properties

$keyword

Methods

parserLicenseTag

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

sets up the link tag

Inherited From parserTag

parserTag::parserTag()

Set up the tag

parserTag::Convert()

Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString()

Returns the text minus any inline tags

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 should only be used in pre-parsing to see if any other text is in the string)

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

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string

$keyword

always 'license'

[ Top ]

Method Summary

parserLicenseTag

parserLicenseTag()

set up the license tag

[ Top ]

Properties

string $keyword = 'license' [line 793]

always 'license'

Redefinition of:

parserLinkTag::$keyword: always 'link'

[ Top ]

Methods

Constructor parserLicenseTag [line 801]

parserLicenseTag parserLicenseTag(
string
$name, string
$link 
)

set up the license tag

Parameters:

string	$name:	unused?
string	$link:	URL to link to

[ Top ]

Documentation generated on Sun, 30 Mar 2008 23:07:45 -0500 by phpDocumentor 1.4.2

	phpDocumentor DocBlockTags

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