phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
XML_Beautifier

Tutorials/Manuals:
Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
EventStack.inc
IntermediateParser.inc
Io.inc
ParserDescCleanup.inc
phpdoc.inc
ProceduralPages.inc
Publisher.inc
Setup.inc.php

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

Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   phpDocumentor_HighlightParser
   phpDocumentor_HighlightWordParser
   phpDocumentor_peardoc2_XML_Beautifier
   phpDocumentor_TutorialHighlightParser
   phpDocumentor_XML_Beautifier_Tokenizer
   ppageParser
   XMLPackagePageParser

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher

DescHTML
   parserB
   parserBr
   parserCode
   parserDescVar
   parserI
   parserKbd
   parserList
   parserPre
   parserSamp

DocBlockTags
   parserAccessTag
   parserExampleTag
   parserFileSourceTag
   parserLicenseTag
   parserLinkTag
   parserMethodTag
   parserNameTag
   parserParamTag
   parserPropertyReadTag
   parserPropertyTag
   parserPropertyWriteTag
   parserReturnTag
   parserSeeTag
   parserStaticvarTag
   parserTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVarTag

Errors
   ErrorTracker
   RecordError
   RecordWarning

InlineTags
   parserExampleInlineTag
   parserIdInlineTag
   parserInheritdocInlineTag
   parserInlineTag
   parserLinkInlineTag
   parserSourceInlineTag
   parserTocInlineTag
   parserTutorialInlineTag

Links
   abstractLink
   classLink
   constLink
   defineLink
   functionLink
   globalLink
   methodLink
   pageLink
   tutorialLink
   varLink

Tutorial
   parserCData
   parserEntity
   parserXMLDocBookTag

ParserData
   parserBase
   parserData
   parserPage
   parserStringWithInlineTags

WordParsers
   ObjectWordParser
   phpDocumentorTWordParser
   WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
   parserClass
   parserConst
   parserDefine
   parserElement
   parserFunction
   parserGlobal
   parserInclude
   parserMethod
   parserPackagePage
   parserTutorial
   parserVar

Class: parserPre

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

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserPre

Used for <pre> in a description

Author(s):

Greg Beaver <cellog@php.net>

Version:

Release: 1.4.2

Copyright:

2002-2007 Gregory Beaver

Methods

Convert

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$type
parserStringWithInlineTags::$value

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

Class: parserBase

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

Class Details

[line 127]
Used for <pre> in a description

Tags:

author:	Greg Beaver <cellog@php.net>
version:	Release: 1.4.2
copyright:	2002-2007 Gregory Beaver
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
todo:	CS cleanup - change package to PhpDocumentor
todo:	CS cleanup - rename class to ParserPre
since:	1.2
license:	LGPL

[ Top ]

Class Methods

method Convert [line 138]

string Convert(
Converter
&$c)

performs the conversion of code tags

Tags:

return:	the converted pre block
todo:	CS cleanup - rename method to convert()
uses:	Converter::PreserveWhiteSpace()

Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)

Parameters:

&$c

the converter object

[ Top ]

Documentation generated on Sun, 30 Mar 2008 23:06:28 -0500 by phpDocumentor 1.4.2