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

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

Class Overview

encapsulates warning information

Variables

Methods

Child classes:

RecordError: encapsulates error information

Inherited Variables

Inherited Methods

Class Details

[line 326]
encapsulates warning information

[ Top ]

Class Variables

$data =

[line 347]

error string

Type:

string

[ Top ]

$file = false

[line 337]

file this error occurred in

Type:

string

[ Top ]

$linenum =

[line 342]

line number of the file this error occurred in

Type:

integer

[ Top ]

$num =

[line 353]

error number

See: Errors.inc

Type:

string

[ Top ]

$type = 'phpDocumentor_warning_descrip'

[line 332]

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

Type:

string

[ Top ]

Method Detail

RecordWarning (Constructor) [line 360]

RecordWarning RecordWarning(
string
$file, integer
$linenum, integer
$num, string
$data...)

Parameters:

string	`$file`	—	filename this error occurred in ($file)
integer	`$linenum`	—	line number this error occurred on ($linenum)
integer	`$num`	—	Error number defined in Errors.inc
string	`$data...`	—	variable number of strings, up to 4, to sprintf based on the error number

[ Top ]

output [line 381]

void output(
[mixed
$string = false])

prints the warning

Overridden in child classes as:

RecordError::output(): prints the error

RecordException::output()

[ Top ]

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