Docs for page Errors.inc

/phpDocumentor/Errors.inc

Description

Error handling for phpDocumentor

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

author: Greg Beaver <[email protected]>
version: CVS: $Id: Errors.inc 253641 2008-02-24 02:35:44Z ashnazg $
copyright: 2001-2008 Gregory Beaver
see: parserDocBlock, parserInclude, parserPage, parserClass
see: parserDefine, parserFunction, parserMethod, parserVar
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
since: 0.4
license: LGPL
filesource: Source Code for this file

Classes

Class	Description
RecordWarning	encapsulates warning information
RecordError	encapsulates error information
ErrorTracker	contains all the errors/warnings

Constants

PDERROR_ACCESS_WRONG_PARAM = 8 (line 77)

warning triggered when the arguments to @access are neither public nor private

PDERROR_BEAUTIFYING_FAILED = 66 (line 343)

warning triggered by an unterminated entity in a tutorial

PDERROR_CANNOT_EXTEND_SELF = 72 (line 384)

warning triggered if someone brilliant tries "class X extends X {"

PDERROR_CANT_HAVE_INLINE_IN_TAGNAME = 36 (line 204)

warning triggered when an inline tag is found inside an xml tag name

in a package page

PDERROR_CANT_NEST_IN_B = 34 (line 195)

warning triggered when another tag is nested in <b>

(not allowed in phpDocumentor)

PDERROR_CHILD_TUTORIAL_NOT_FOUND = 40 (line 223)

warning triggered when a tutorial's child in the .ini file doesn't exist in the

package and subpackage of the parent

PDERROR_CLASS_CONFLICT = 17 (line 115)

warning triggered when classes in the same package have the same name

PDERROR_CLASS_EXISTS = 4 (line 59)

warning triggered when inheritance could be from more than one class

PDERROR_CLASS_NOT_IN_PACKAGE = 30 (line 176)

warning triggered when a getClassByPackage is called and can't find the class

PDERROR_CLASS_PARENT_NOT_FOUND = 29 (line 172)

warning triggered when an entire page is ignored because of @access private

todo: I think this description is a copy/paste that was never updated

PDERROR_CONVERTER_NOT_FOUND = 6 (line 68)

warning triggered when a converter is passed to

phpDocumentor_IntermediateParser::addConverter() that is not a class

PDERROR_CONVERTER_OVR_GFCT = 54 (line 293)

warning triggered when a child converter doesn't override

getFormattedClassTrees()

PDERROR_DANGEROUS_PHP_BUG_EXISTS = 80 (line 417)

warning triggered when the PHP version being used has dangerous bug/behavior

PDERROR_DB_TEMPLATE_UNTERMINATED = 32 (line 186)

warning triggered when a docblock template is never turned off

with /**#@-* / (no space)

PDERROR_DOCBLOCK_CONFLICT = 68 (line 367)

warning triggered by a page-level docblock preceding a source element

<?php
/**
* Page-level DocBlock
* @package pagepackage
***/
include 'file.php';

PDERROR_DOCBLOCK_GOES_CLASS = 70 (line 376)

warning triggered when the first docblock in a file with a @package tag precedes a class. In this case, the class gets the docblock.

PDERROR_DUMB_USES = 73 (line 388)

warning triggered by improper "@uses blah"

PDERROR_ELEMENT_IGNORED = 25 (line 153)

warning triggered when a duplicate element is encountered that will be

ignored by the documentor

PDERROR_EMPTY_EXAMPLE_TITLE = 63 (line 331)

warning triggered by @example path/to/example with no title

PDERROR_EXAMPLE_NOT_FOUND = 48 (line 265)

warning triggered when an example's path from @example /path/to/example.php

is not found

PDERROR_FUNCTION_HAS_NONAME = 67 (line 354)

warning triggered by a function with no name

 function ($params)
 {
 }

triggers this error

PDERROR_GLOBAL_NOT_FOUND = 21 (line 133)

warning triggered when there are multiple @name tags in a docblock

todo: I think this description is a copy/paste that was never updated

PDERROR_ID_MUST_BE_INLINE = 51 (line 280)

warning triggered when an id attribute in a tutorial docbook tag is not

an {@id} inline tag

PDERROR_IGNORE_TAG_IGNORED = 24 (line 148)

warning triggered when an @ignore tag is used in a DocBlock preceding

a method, variable, include, or global variable

PDERROR_ILLEGAL_PACKAGENAME = 14 (line 101)

warning triggered when the package or subpackage name is illegal

PDERROR_INHERITANCE_CONFLICT = 5 (line 63)

warning triggered when inheritance could be from more than one class

PDERROR_INHERITDOC_DONT_WORK_HERE = 62 (line 327)

warning triggered by {@inheritdoc} in a non-inheritable situation

PDERROR_INLINETAG_IN_SEE = 50 (line 275)

warning triggered when an example's path from @example /path/to/example.php

is not found

PDERROR_INTERNAL_NOT_CLOSED = 52 (line 284)

warning triggered when an {@internal}} tag is not closed

PDERROR_INVALID_VALUES = 75 (line 396)

warning triggered if a command line option does not have a valid value passed in

PDERROR_LOOP_RECURSION_LIMIT_REACHED = 82 (line 426)

warning triggered when the a loop recursion tripwire has been tripped

PDERROR_MALFORMED_GLOBAL_TAG = 23 (line 143)

warning triggered when there are multiple @name tags in a docblock

todo: I think this description is a copy/paste that was never updated

PDERROR_MALFORMED_TAG = 60 (line 319)

warning triggered by an empty tag

PDERROR_MISSING_PROPERTY_TAG_NAME = 79 (line 413)

warning triggered when any of {@property}}, {@property-read}},

{@property-write}}, or {@method}} tag does not have name

PDERROR_MULTIPLE_ACCESS_TAGS = 9 (line 81)

warning triggered when there are multiple @access tags in a docblock

PDERROR_MULTIPLE_CATEGORY_TAGS = 61 (line 323)

warning triggered by more than 1 @category tag

PDERROR_MULTIPLE_GLOBAL_TAGS = 22 (line 138)

warning triggered when there are multiple @name tags in a docblock

todo: I think this description is a copy/paste that was never updated

PDERROR_MULTIPLE_NAME_TAGS = 19 (line 123)

warning triggered when there are multiple @name tags in a docblock

PDERROR_MULTIPLE_PACKAGE_TAGS = 12 (line 93)

warning triggered when there are multiple @package tags in a docblock

PDERROR_MULTIPLE_PARENT = 1 (line 46)

warning triggered when inheritance could be from more than one class

PDERROR_MULTIPLE_RETURN_TAGS = 10 (line 85)

warning triggered when there are multiple @return tags in a docblock

PDERROR_MULTIPLE_SUBPACKAGE_TAGS = 13 (line 97)

warning triggered when there are multiple @subpackage tags in a docblock

PDERROR_MULTIPLE_VAR_TAGS = 11 (line 89)

warning triggered when there are multiple @var tags in a docblock

PDERROR_NAME_ALIAS_SAME_AS_TARGET = 81 (line 422)

warning triggered when the alias value in an page-level docblock's @name tag

is the same value as the target filename is it supposed to alias

PDERROR_NEED_WHITESPACE = 28 (line 167)

warning triggered when an entire page is ignored because of @access private

todo: I think this description is a copy/paste that was never updated

PDERROR_NESTED_INTERNAL = 76 (line 400)

warning triggered when {@internal}} is nested inside another {@internal}}

PDERROR_NOTODO_INCLUDE = 77 (line 404)

warning triggered when @todo is used on an include element

PDERROR_NO_CONVERTERS = 7 (line 73)

warning triggered when a converter is passed to

phpDocumentor_IntermediateParser::addConverter() that is not a class

PDERROR_NO_CONVERTER_HANDLER = 49 (line 270)

warning triggered when an example's path from @example /path/to/example.php

is not found

PDERROR_NO_DOCBOOK_ID = 71 (line 380)

warning triggered in tutorial parsing if there is a missing {@id} inline tag

PDERROR_NO_PACKAGE_TAG = 46 (line 254)

warning triggered when no @package tag is used in a page-level

or class-level DocBlock

PDERROR_NO_PAGE_LEVELDOCBLOCK = 69 (line 371)

warning triggered when a file does not contain a page-level docblock

PDERROR_OVERRIDDEN_PACKAGE_TAGS = 15 (line 106)

warning triggered when there a @package tag is used in a function,

define, method, var or include

PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS = 16 (line 111)

warning triggered when there a @subpackage tag is used in a function,

define, method, var or include

PDERROR_PACKAGECAT_SET = 55 (line 298)

warning triggered when a package is already associated with a category, and

a new association is found

PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE = 20 (line 128)

warning triggered when there are multiple @name tags in a docblock

todo: I think this description is a copy/paste that was never updated

PDERROR_PARENT_NOT_FOUND = 2 (line 50)

warning triggered when parent class doesn't exist

PDERROR_PARSEPRIVATE = 26 (line 157)

warning triggered when an entire page is ignored because of @access private

PDERROR_PDFFUNCTION_NO_FUNC = 41 (line 228)

warning triggered when a <pdffunction:funcname /> tag is used in the PDF

Converter and no funcname is present (<pdffunction: />)

PDERROR_PDF_METHOD_DOESNT_EXIST = 42 (line 233)

warning triggered when a <pdffunction:funcname /> tag is used in the PDF

Converter and funcname is not a Cezpdf method

PDERROR_PDF_TEMPVAR_DOESNT_EXIST = 43 (line 239)

warning triggered when a <pdffunction:funcname arg=$tempvar/> tag

is used in the PDF Converter and "tempvar" is not set from the return of a previous pdffunction tag

PDERROR_PRIVATE_ASSUMED = 47 (line 260)

warning triggered when no @access private tag is used in a

global variable/method/var with _ as first char in name and --pear was specified

PDERROR_SOURCECODE_IGNORED = 59 (line 315)

warning triggered by sourcecode="on", if PHP < 4.3.0

PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND = 31 (line 181)

warning triggered when a { @source } inline tag is used in a docblock not

preceding a function

PDERROR_SOURCE_TAG_IGNORED = 53 (line 288)

warning triggered when an {@source} tag is found in a short description

PDERROR_TAG_NOT_HANDLED = 58 (line 311)

warning triggered by @filesource, if PHP < 4.3.0

PDERROR_TEMPLATEDIR_DOESNT_EXIST = 64 (line 335)

warning triggered by non-existent template directory

PDERROR_TEXT_OUTSIDE_LI = 56 (line 303)

warning triggered when text in a docblock list is not contained in

an <li> opening tag

PDERROR_TUTORIAL_IS_OWN_CHILD = 38 (line 213)

warning triggered when a tutorial lists itself as a child tutorial

PDERROR_TUTORIAL_IS_OWN_GRANDPA = 39 (line 218)

warning triggered when a tutorial's child lists the parent tutorial

as a child tutorial

PDERROR_TUTORIAL_NOT_FOUND = 37 (line 209)

warning triggered when a tutorial is referenced

via @tutorial/{ @tutorial} and is not found

PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND = 44 (line 244)

warning triggered when a subsection's title is asked for, but the subsection

is not found

PDERROR_UL_IN_UL = 74 (line 392)

warning triggered if <ul> is nested inside <ul> and not <li>

PDERROR_UNCLOSED_TAG = 57 (line 307)

warning triggered when a DocBlock html tag is unclosed

PDERROR_UNDOCUMENTED_ELEMENT = 78 (line 408)

warning triggered when a class or method hasn't got docblock

PDERROR_UNKNOWN_COMMANDLINE = 27 (line 162)

warning triggered when an entire page is ignored because of @access private

todo: I think this description is a copy/paste that was never updated

PDERROR_UNKNOWN_TAG = 18 (line 119)

warning triggered when classes in the same package have the same name

PDERROR_UNMATCHED_LIST_TAG = 33 (line 190)

warning triggered when a docblock has an unmatched <ol> or <ul>

PDERROR_UNMATCHED_TUTORIAL_TAG = 35 (line 199)

warning triggered when a docbook tag is not properly matched

PDERROR_UNTERMINATED_ATTRIB = 45 (line 249)

warning triggered when a subsection's title is asked for, but the subsection

is not found

PDERROR_UNTERMINATED_ENTITY = 65 (line 339)

warning triggered by an unterminated entity in a tutorial

PDERROR_UNTERMINATED_INLINE_TAG = 3 (line 55)

warning triggered when an {@inline tag} is not terminated

(no } before the * / ending the comment)

Variables

ErrorTracker $phpDocumentor_errors (line 1097)

name: $phpDocumentor_errors

array $phpDocumentor_error_descrip (line 555)

Error messages for phpDocumentor parser errors

name: $phpDocumentor_error_descrip

array $phpDocumentor_warning_descrip (line 433)

Error messages for phpDocumentor parser warnings

name: $phpDocumentor_warning_descrip

Functions

addError (line 1110)

add an Error

see: ErrorTracker::addError()
todo: CS Cleanup - do I need to add $data to the method signature?

void addError (integer $num, string $data...)

integer $num: error number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

addErrorDie (line 1134)

like addError() but exits parsing

global: ErrorTracker $phpDocumentor_errors: repository for all errors generated by phpDocumentor
see: ErrorTracker::addError()
todo: CS Cleanup - do I need to add $data to the method signature?

void addErrorDie (integer $num, string $data...)

integer $num: error number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

addWarning (line 1160)

add a Warning

global: ErrorTracker $phpDocumentor_errors: repository for all errors generated by phpDocumentor
see: ErrorTracker::addWarning()
todo: CS Cleanup - do I need to add $data to the method signature?

void addWarning (integer $num, string $data...)

integer $num: warning number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

Documentation generated on Mon, 05 Dec 2011 21:09:38 -0600 by phpDocumentor 1.4.4