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: RecordException

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

Class Overview

RecordWarning
   |
   --RecordError
      |
      --RecordException

encapsulates error information

Variables

$info
$type

Methods

Inherited Variables

Class: RecordWarning

RecordWarning::$data
RecordWarning::$file
RecordWarning::$linenum
RecordWarning::$num

Inherited Methods

Class: RecordError

RecordError::output(): prints the error

Class: RecordWarning

RecordWarning::RecordWarning()
RecordWarning::output(): prints the warning

Class Details

[line 431]
encapsulates error information

[ Top ]

Class Variables

$info = ''

[line 439]

Type:

mixed

[ Top ]

$type = 'phpDocumentor_exception_descrip'

[line 437]

name of global variable that descriptors for this warning/error is kept

Type:	string
Overrides:	Array

[ Top ]

Method Detail

RecordException (Constructor) [line 472]

RecordException RecordException(
integer
$num, string
$file, integer
$linenum, [array
$data = false])

Global: array $setting: we use the target attribute to tell the user where phpdoc_exceptions.log is located

Parameters:

string	`$file`	—	filename this error occurred in ($file)
integer	`$linenum`	—	line number this error occurred on ($linenum)
integer	`$num`	—	Exception number defined in Errors.inc
array	`$data`	—	array of variables to var_dump

[ Top ]

output [line 441]

void output(
[mixed
$string = false])

Overrides RecordError::output() (prints the error)

[ Top ]

writeException [line 456]

void writeException(
mixed
$data)

writes information needed to debug a phpDocumentor exception.

An exception is distinguished from an error or warning in that a bug in phpDocumentor raises an exception, rather than a mistake in the DocBlock or files parsed. Exception output log is very useful in helping us to debug phpDocumentor bugs

Global: array $setting: we use the target attribute to write the exception log to the target directory

[ Top ]

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