phpDocumentor

[ ] [ ] [ ]

Packages:
PhpDocumentor
apidoc
Converters
HTML_TreeMenu
Pdf-php
PEAR
phpDocumentor
Smarty
tests

Tutorials/Manuals:
Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor 1.2.0 Manual
  - phpDocumentor 1.2.0 Tutorial
    - Documentable PHP Elements
    - phpDocumentor Tutorials
  - phpDocumentor tags
    - @access
    - @author
    - @copyright
    - @deprecated
    - @example
    - @filesource
    - @global
    - @ignore
    - @internal
    - @link
    - @name
    - @package
    - @param
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

Classes.inc
common.inc.php
create_examples.php
EventStack.inc
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Template.inc
WordParser.inc

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
XMLpackagePageParser.inc

subpackage Tutorial

PackagePageElements.inc

Classes:

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
Template

DescHTML
   parserB
   parserBr
   parserCode
   parserI
   parserList
   parserPre

PhpDocumentor-1.2.0beta2
   classLink
   defineLink
   DirNode
   functionLink
   globalLink
   methodLink
   pageLink
   parserAccessTag
   parserClass
   parserDefine
   parserElement
   parserExampleTag
   parserFileSourceTag
   parserFunction
   parserGlobal
   parserIdInlineTag
   parserInclude
   parserInheritdocInlineTag
   parserLinkInlineTag
   parserLinkTag
   parserMethod
   parserNameTag
   parserPackagePage
   parserParamTag
   parserReturnTag
   parserSeeTag
   parserSourceInlineTag
   parserSourceTag
   parserStaticvarTag
   parserStringWithInlineTags
   parserTocInlineTag
   parserTutorial
   parserTutorialInlineTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVar
   parserVarTag
   phpDocumentorTWordParser
   RecordException
   tutorialLink
   varLink

DocBlockTags
parserTag

Errors
   ErrorTracker
   RecordError
   RecordWarning

InlineTags
parserInlineTag

Links
abstractLink

Tutorial
parserCData
parserXMLDocBookTag

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   ppageParser
   XMLPackagePageParser

ParserData
   parserBase
   parserData
   parserPage

WordParsers
ObjectWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

Class: parserDesc

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserDocBlock.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc

represents a short or long description in a DocBlock (parserDocBlock)

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserDocBlock.inc,v 1.27 2003/01/18 07:25:19 CelloG Exp $

Variables

$type

Methods

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$cache
parserStringWithInlineTags::$value

Class: parserBase

parserBase::$linenum

Inherited Methods

Class: 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
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 15]
represents a short or long description in a DocBlock (parserDocBlock)

Version: $Id: ParserDocBlock.inc,v 1.27 2003/01/18 07:25:19 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$type = '_desc'

[line 22]

Type is used by many functions to skip the hassle of if get_class($blah) == 'parserBlah'

always '_desc'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

add [line 28]

void add(
mixed
$stringOrClass)

Overrides parserStringWithInlineTags::add() (equivalent to the . operator ($a = $b . $c))

Parameters:

mixed $stringOrClass — like parserStringWithInlineTags::add(), this can be a string or parserInlineTag, but it can also be a parserStringWithInlineTags, and the contents will be merged

[ Top ]

hasInheritDoc [line 48]

boolean hasInheritDoc(
)

Return: whether this desc has an { @inheritdoc} inline tag

[ Top ]

replaceInheritDoc [line 56]

void replaceInheritDoc(
mixed
$desc)

[ Top ]

Documentation generated on Fri, 30 Apr 2004 22:10:23 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.