$phpDocumentor_errors (line 1097)

ErrorTracker $phpDocumentor_errors : new ErrorTracker

• name: - $phpDocumentor_errors

$phpDocumentor_error_descrip (line 555)

array $phpDocumentor_error_descrip : array(
PDERROR_UNTERMINATED_INLINE_TAG =>
'Inline tag {@%s} in tag %s is unterminated, "%s"'
,
PDERROR_CLASS_EXISTS =>
'Class %s already exists in package "%s"'
,
PDERROR_CONVERTER_NOT_FOUND =>
'Converter %s specified by --output command-line option is not a class'
,
PDERROR_NO_CONVERTERS =>
'No Converters have been specified by --output command-line option'
,
PDERROR_ACCESS_WRONG_PARAM =>
'@access was passed neither "public" nor "private." Was passed: "%s"'
,
PDERROR_MULTIPLE_ACCESS_TAGS =>
'DocBlock has multiple @access tags, illegal. ' .
'ignoring additional tag "@access %s"'
,
PDERROR_MULTIPLE_RETURN_TAGS =>
'DocBlock has multiple @return tags, illegal. ' .
'ignoring additional tag "@return %s %s"'
,
PDERROR_MULTIPLE_VAR_TAGS =>
'DocBlock has multiple @var tags, illegal. ' .
'ignoring additional tag "@var %s %s"'
,
PDERROR_MULTIPLE_PACKAGE_TAGS =>
'DocBlock has multiple @package tags, illegal. ' .
'ignoring additional tag "@package %s"'
,
PDERROR_MULTIPLE_SUBPACKAGE_TAGS =>
'DocBlock has multiple @subpackage tags, illegal. ' .
'ignoring additional tag "@subpackage %s"'
,
PDERROR_ILLEGAL_PACKAGENAME =>
'@%s tag has illegal %s name "%s"'
,
PDERROR_OVERRIDDEN_PACKAGE_TAGS =>
'%s %s\'s DocBlock has @package tag, illegal. ' .
'ignoring tag "@package %s"'
,
PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS =>
'"%s" %s\'s DocBlock has @subpackage tags, illegal. ' .
'ignoring tag "@subpackage %s"'
,
PDERROR_CLASS_CONFLICT =>
'class "%s" has multiple declarations in package %s, ' .
'in file %s and file %s, documentation will have output errors!'
,
PDERROR_MULTIPLE_NAME_TAGS =>
'DocBlock has multiple @name tags, illegal. ' .
'ignoring additional tag "@name %s"'
,
PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE =>
'-po (packageoutput) option deletes parent file "%s" containing class' .
' "%s."' . "\n" . ' Try using --defaultpackagename (-dn) %s to ' .
'include the parent file in the same package as the class'
,
PDERROR_GLOBAL_NOT_FOUND =>
'global variable %s specified in @global tag was never found'
,
PDERROR_MULTIPLE_GLOBAL_TAGS =>
'@global define tag already used for global variable "%s", ' .
'ignoring @global %s'
,
PDERROR_MALFORMED_GLOBAL_TAG =>
'incorrect @global syntax. ' .
'Should be @global vartype $varname or @global vartype description'
,
PDERROR_UNKNOWN_COMMANDLINE =>
'Unknown command-line option "%s" encountered, use phpdoc -h for help'
,
PDERROR_NEED_WHITESPACE =>
'phpDocumentor programmer error - wordparser whitespace set to false ' .
'in handleDocBlock, notify developers. You should never see this error'
,
PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND =>
'{@source} tag used in a docblock that isn\'t preceding a function'
,
PDERROR_UNMATCHED_LIST_TAG =>
'unmatched ol or ul tag in DocBlock, parsing will be incorrect'
,
PDERROR_CANT_NEST_IN_B =>
'Can\'t nest a code, pre, ul, or ol tag in a b tag in ' .
'phpDocumentor DocBlock (%s tag nested)'
,
PDERROR_UNMATCHED_TUTORIAL_TAG =>
'While parsing extended documentation, "%s" tag was matched ' .
'with "%s" endtag, missing endtag'."\ntag contents:\"%s\""
,
PDERROR_CANT_HAVE_INLINE_IN_TAGNAME =>
'Can\'t have an inline tag inside a package page XML tag!'
,
PDERROR_TUTORIAL_IS_OWN_CHILD =>
'Tutorial %s lists itself as its own child in %s, illegal'
,
PDERROR_TUTORIAL_IS_OWN_GRANDPA =>
'Tutorial %s\'s child %s lists %s as its child in %s, illegal'
,
PDERROR_PDFFUNCTION_NO_FUNC =>
'Invalid pdffunction syntax: "<pdffunction: />", ' .
'should be "<pdffunction:functionname [arg="value"...]/>"'
,
PDERROR_PDF_TEMPVAR_DOESNT_EXIST =>
'<pdffunction:%s arg=%s /> called ' .
'but temporary variable "%s" doesn\'t exist'
,
PDERROR_UNTERMINATED_ATTRIB =>
'Tutorial tag %s attribute %s is unterminated, current value "%s"'
,
PDERROR_NO_CONVERTER_HANDLER =>
'Handler for element of type "%s" called, but %s is not a method of %s'
,
PDERROR_INLINETAG_IN_SEE =>
'Inline tags are not allowed in a @see tag'
,
PDERROR_ID_MUST_BE_INLINE =>
'<%s id="%s"> must be <%s id="{@id %s}">'
,
PDERROR_INTERNAL_NOT_CLOSED =>
'{@internal was never terminated with }}'
,
PDERROR_CONVERTER_OVR_GFCT =>
'Converter "%s" must override getFormattedClassTrees() but doesn\'t'
,
PDERROR_TEXT_OUTSIDE_LI =>
'Text cannot be outside of li tag in a DocBlock list, ' .
'parsing will be incorrect'
,
PDERROR_UNCLOSED_TAG =>
'Unclosed %s tag in DocBlock, parsing will be incorrect'
,
PDERROR_TAG_NOT_HANDLED =>
'"%s" tag is not available in PHP built without tokenizer support, tag ignored'
,
PDERROR_MALFORMED_TAG =>
'"%s" tag was used without any parameters, illegal'
,
PDERROR_MULTIPLE_CATEGORY_TAGS =>
'package has multiple @category tags, ignoring "@category %s"'
,
PDERROR_TEMPLATEDIR_DOESNT_EXIST =>
'template directory "%s" does not exist'
,
PDERROR_UNTERMINATED_ENTITY =>
'entity &%s is unterminated'
,
PDERROR_FUNCTION_HAS_NONAME =>
'function has no name (PHP error - test your file before parsing!)'
,
PDERROR_CANNOT_EXTEND_SELF =>
'class %s cannot extend itself - TEST YOUR CODE BEFORE PARSING'
,
PDERROR_DUMB_USES =>
'@uses can only link to string data'
,
PDERROR_UL_IN_UL =>
'ul/ol tags cannot be directly nested inside ul/ol, nest inside li'
,
PDERROR_INVALID_VALUES =>
'command %s was passed "%s" but must be one of %s'
,
PDERROR_NESTED_INTERNAL =>
'{@internal}} cannot be nested inside {@internal}}'
,
PDERROR_DANGEROUS_PHP_BUG_EXISTS =>
'Dangerous PHP Bug exists in PHP version %s that can be triggered ' .
'by this parse (see PHP Bug #%s and PEAR Bug #%s)'
,
PDERROR_LOOP_RECURSION_LIMIT_REACHED =>
'An internal loop in PhpDocumentor has reached its preset ' .
'recursion limit, preventing a possible infinite loop condition.'
)

Error messages for phpDocumentor parser errors

• name: - $phpDocumentor_error_descrip

$phpDocumentor_warning_descrip (line 433)

array $phpDocumentor_warning_descrip : array(
PDERROR_MULTIPLE_PARENT =>
'Class %s has multiple possible parents, package inheritance aborted'
,
PDERROR_PARENT_NOT_FOUND =>
'Class %s parent %s not found'
,
PDERROR_INHERITANCE_CONFLICT =>
'Class %s in file %s has multiple possible parents named %s. ' .
'Cannot resolve name conflict,' . "\n" .
' try ignoring a file that contains the conflicting parent class'
,
PDERROR_UNKNOWN_TAG =>
'Unknown tag "@%s" used'
,
PDERROR_IGNORE_TAG_IGNORED =>
'@ignore tag used for %s element "%s" will be ignored'
,
PDERROR_ELEMENT_IGNORED =>
"\n" . 'duplicate %s element "%s" in file %s will be ignored.' . "\n" .
'Use an @ignore tag on the original ' .
'if you want this case to be documented.'
,
PDERROR_PARSEPRIVATE =>
"entire page %s ignored because of @access private." . "\n" .
"Choose -pp to enable parsing of private elements"
,
PDERROR_CLASS_PARENT_NOT_FOUND =>
"class %s in package %s parent not found in @see parent::%s"
,
PDERROR_CLASS_NOT_IN_PACKAGE =>
"class %s was not found in package %s"
,
PDERROR_DB_TEMPLATE_UNTERMINATED =>
'docblock template never terminated with /**#@-*/'
,
PDERROR_PDF_METHOD_DOESNT_EXIST =>
'<pdffunction:%s /> called, but pdf method "%s" doesn\'t exist'
,
PDERROR_TUTORIAL_NOT_FOUND =>
"tutorial \"%s\" not found, does it exist?"
,
PDERROR_CHILD_TUTORIAL_NOT_FOUND =>
'child tutorial "%s" listed in %s not found ' .
'in parent package "%s" subpackage "%s"'
,
PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND =>
'tutorial %s subsection "%s" doesn\'t exist, ' .
'but its title was asked for'
,
PDERROR_NO_PACKAGE_TAG =>
'no @package tag was used in a DocBlock for %s %s'
,
PDERROR_PRIVATE_ASSUMED =>
'%s "%s" is assumed to be @access private because its name ' .
'starts with _, but has no @access tag'
,
PDERROR_EXAMPLE_NOT_FOUND =>
'example file "%s" does not exist'
,
PDERROR_SOURCE_TAG_IGNORED =>
'{@source} can only be used in the long description, ' .
'not in the short description: "%s"'
,
PDERROR_PACKAGECAT_SET =>
'package %s is already in category %s, ' .
'will now replace with category %s'
,
PDERROR_SOURCECODE_IGNORED =>
'sourcecode command-line option is ignored ' .
'when your PHP build has no tokenizer support'
,
PDERROR_INHERITDOC_DONT_WORK_HERE =>
'{@inheritdoc} can only be used in the docblock of a child class'
,
PDERROR_EMPTY_EXAMPLE_TITLE =>
'Example file found at "%s" has no title, using "%s"'
,
PDERROR_DOCBLOCK_CONFLICT =>
'Page-level DocBlock precedes "%s %s", ' .
'use another DocBlock to document the source element'
,
PDERROR_NO_PAGE_LEVELDOCBLOCK =>
'File "%s" has no page-level DocBlock, ' .
'use @package in the first DocBlock to create one'
,
PDERROR_DOCBLOCK_GOES_CLASS =>
'DocBlock would be page-level, but precedes class "%s", ' .
'use another DocBlock to document the file'
,
PDERROR_NO_DOCBOOK_ID =>
'Tutorial section %s "%s" has no id="{@id subsection}" tag ' .
'({@id} for refentry)'
,
PDERROR_BEAUTIFYING_FAILED =>
'Beautifying failed: %s'
,
PDERROR_NOTODO_INCLUDE =>
'@todo on an include element is ignored (line %s, file %s)'
,
PDERROR_UNDOCUMENTED_ELEMENT =>
'%s "%s" has no %s-level DocBlock.'
,
PDERROR_MISSING_PROPERTY_TAG_NAME =>
'@%s magic tag does not have name, illegal. Ignoring tag "@%s %s %s"'
,
PDERROR_NAME_ALIAS_SAME_AS_TARGET =>
'@name value is the same as the filename it is supposed to alias'
)

Error messages for phpDocumentor parser warnings

• name: - $phpDocumentor_warning_descrip

PDERROR_ACCESS_WRONG_PARAM (line 77)

PDERROR_ACCESS_WRONG_PARAM : 8

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

PDERROR_BEAUTIFYING_FAILED (line 343)

PDERROR_BEAUTIFYING_FAILED : 66

warning triggered by an unterminated entity in a tutorial

PDERROR_CANNOT_EXTEND_SELF (line 384)

PDERROR_CANNOT_EXTEND_SELF : 72

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

PDERROR_CANT_HAVE_INLINE_IN_TAGNAME (line 204)

PDERROR_CANT_HAVE_INLINE_IN_TAGNAME : 36

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

PDERROR_CANT_NEST_IN_B (line 195)

PDERROR_CANT_NEST_IN_B : 34

warning triggered when another tag is nested in &lt;b&gt;

PDERROR_CHILD_TUTORIAL_NOT_FOUND (line 223)

PDERROR_CHILD_TUTORIAL_NOT_FOUND : 40

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

PDERROR_CLASS_CONFLICT (line 115)

PDERROR_CLASS_CONFLICT : 17

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

PDERROR_CLASS_EXISTS (line 59)

PDERROR_CLASS_EXISTS : 4

warning triggered when inheritance could be from more than one class

PDERROR_CLASS_NOT_IN_PACKAGE (line 176)

PDERROR_CLASS_NOT_IN_PACKAGE : 30

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

PDERROR_CLASS_PARENT_NOT_FOUND (line 172)

PDERROR_CLASS_PARENT_NOT_FOUND : 29

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 (line 68)

PDERROR_CONVERTER_NOT_FOUND : 6

warning triggered when a converter is passed to

PDERROR_CONVERTER_OVR_GFCT (line 293)

PDERROR_CONVERTER_OVR_GFCT : 54

warning triggered when a child converter doesn't override

PDERROR_DANGEROUS_PHP_BUG_EXISTS (line 417)

PDERROR_DANGEROUS_PHP_BUG_EXISTS : 80

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

PDERROR_DB_TEMPLATE_UNTERMINATED (line 186)

PDERROR_DB_TEMPLATE_UNTERMINATED : 32

warning triggered when a docblock template is never turned off

PDERROR_DOCBLOCK_CONFLICT (line 367)

PDERROR_DOCBLOCK_CONFLICT : 68

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

PDERROR_DOCBLOCK_GOES_CLASS (line 376)

PDERROR_DOCBLOCK_GOES_CLASS : 70

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 (line 388)

PDERROR_DUMB_USES : 73

warning triggered by improper "@uses blah"

PDERROR_ELEMENT_IGNORED (line 153)

PDERROR_ELEMENT_IGNORED : 25

warning triggered when a duplicate element is encountered that will be

PDERROR_EMPTY_EXAMPLE_TITLE (line 331)

PDERROR_EMPTY_EXAMPLE_TITLE : 63

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

PDERROR_EXAMPLE_NOT_FOUND (line 265)

PDERROR_EXAMPLE_NOT_FOUND : 48

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

PDERROR_FUNCTION_HAS_NONAME (line 354)

PDERROR_FUNCTION_HAS_NONAME : 67

warning triggered by a function with no name

 function ($params)
 {
 }

PDERROR_GLOBAL_NOT_FOUND (line 133)

PDERROR_GLOBAL_NOT_FOUND : 21

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 (line 280)

PDERROR_ID_MUST_BE_INLINE : 51

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

PDERROR_IGNORE_TAG_IGNORED (line 148)

PDERROR_IGNORE_TAG_IGNORED : 24

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

PDERROR_ILLEGAL_PACKAGENAME (line 101)

PDERROR_ILLEGAL_PACKAGENAME : 14

warning triggered when the package or subpackage name is illegal

PDERROR_INHERITANCE_CONFLICT (line 63)

PDERROR_INHERITANCE_CONFLICT : 5

warning triggered when inheritance could be from more than one class

PDERROR_INHERITDOC_DONT_WORK_HERE (line 327)

PDERROR_INHERITDOC_DONT_WORK_HERE : 62

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

PDERROR_INLINETAG_IN_SEE (line 275)

PDERROR_INLINETAG_IN_SEE : 50

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

PDERROR_INTERNAL_NOT_CLOSED (line 284)

PDERROR_INTERNAL_NOT_CLOSED : 52

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

PDERROR_INVALID_VALUES (line 396)

PDERROR_INVALID_VALUES : 75

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

PDERROR_LOOP_RECURSION_LIMIT_REACHED (line 426)

PDERROR_LOOP_RECURSION_LIMIT_REACHED : 82

warning triggered when the a loop recursion tripwire has been tripped

PDERROR_MALFORMED_GLOBAL_TAG (line 143)

PDERROR_MALFORMED_GLOBAL_TAG : 23

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 (line 319)

PDERROR_MALFORMED_TAG : 60

warning triggered by an empty tag

PDERROR_MISSING_PROPERTY_TAG_NAME (line 413)

PDERROR_MISSING_PROPERTY_TAG_NAME : 79

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

PDERROR_MULTIPLE_ACCESS_TAGS (line 81)

PDERROR_MULTIPLE_ACCESS_TAGS : 9

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

PDERROR_MULTIPLE_CATEGORY_TAGS (line 323)

PDERROR_MULTIPLE_CATEGORY_TAGS : 61

warning triggered by more than 1 @category tag

PDERROR_MULTIPLE_GLOBAL_TAGS (line 138)

PDERROR_MULTIPLE_GLOBAL_TAGS : 22

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 (line 123)

PDERROR_MULTIPLE_NAME_TAGS : 19

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

PDERROR_MULTIPLE_PACKAGE_TAGS (line 93)

PDERROR_MULTIPLE_PACKAGE_TAGS : 12

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

PDERROR_MULTIPLE_PARENT (line 46)

PDERROR_MULTIPLE_PARENT : 1

warning triggered when inheritance could be from more than one class

PDERROR_MULTIPLE_RETURN_TAGS (line 85)

PDERROR_MULTIPLE_RETURN_TAGS : 10

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

PDERROR_MULTIPLE_SUBPACKAGE_TAGS (line 97)

PDERROR_MULTIPLE_SUBPACKAGE_TAGS : 13

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

PDERROR_MULTIPLE_VAR_TAGS (line 89)

PDERROR_MULTIPLE_VAR_TAGS : 11

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

PDERROR_NAME_ALIAS_SAME_AS_TARGET (line 422)

PDERROR_NAME_ALIAS_SAME_AS_TARGET : 81

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

PDERROR_NEED_WHITESPACE (line 167)

PDERROR_NEED_WHITESPACE : 28

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 (line 400)

PDERROR_NESTED_INTERNAL : 76

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

PDERROR_NOTODO_INCLUDE (line 404)

PDERROR_NOTODO_INCLUDE : 77

warning triggered when @todo is used on an include element

PDERROR_NO_CONVERTERS (line 73)

PDERROR_NO_CONVERTERS : 7

warning triggered when a converter is passed to

PDERROR_NO_CONVERTER_HANDLER (line 270)

PDERROR_NO_CONVERTER_HANDLER : 49

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

PDERROR_NO_DOCBOOK_ID (line 380)

PDERROR_NO_DOCBOOK_ID : 71

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

PDERROR_NO_PACKAGE_TAG (line 254)

PDERROR_NO_PACKAGE_TAG : 46

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

PDERROR_NO_PAGE_LEVELDOCBLOCK (line 371)

PDERROR_NO_PAGE_LEVELDOCBLOCK : 69

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

PDERROR_OVERRIDDEN_PACKAGE_TAGS (line 106)

PDERROR_OVERRIDDEN_PACKAGE_TAGS : 15

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

PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS (line 111)

PDERROR_OVERRIDDEN_SUBPACKAGE_TAGS : 16

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

PDERROR_PACKAGECAT_SET (line 298)

PDERROR_PACKAGECAT_SET : 55

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

PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE (line 128)

PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE : 20

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 (line 50)

PDERROR_PARENT_NOT_FOUND : 2

warning triggered when parent class doesn't exist

PDERROR_PARSEPRIVATE (line 157)

PDERROR_PARSEPRIVATE : 26

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

PDERROR_PDFFUNCTION_NO_FUNC (line 228)

PDERROR_PDFFUNCTION_NO_FUNC : 41

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

PDERROR_PDF_METHOD_DOESNT_EXIST (line 233)

PDERROR_PDF_METHOD_DOESNT_EXIST : 42

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

PDERROR_PDF_TEMPVAR_DOESNT_EXIST (line 239)

PDERROR_PDF_TEMPVAR_DOESNT_EXIST : 43

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

PDERROR_PRIVATE_ASSUMED (line 260)

PDERROR_PRIVATE_ASSUMED : 47

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

PDERROR_SOURCECODE_IGNORED (line 315)

PDERROR_SOURCECODE_IGNORED : 59

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

PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND (line 181)

PDERROR_SOURCE_TAG_FUNCTION_NOT_FOUND : 31

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

PDERROR_SOURCE_TAG_IGNORED (line 288)

PDERROR_SOURCE_TAG_IGNORED : 53

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

PDERROR_TAG_NOT_HANDLED (line 311)

PDERROR_TAG_NOT_HANDLED : 58

warning triggered by @filesource, if PHP < 4.3.0

PDERROR_TEMPLATEDIR_DOESNT_EXIST (line 335)

PDERROR_TEMPLATEDIR_DOESNT_EXIST : 64

warning triggered by non-existent template directory

PDERROR_TEXT_OUTSIDE_LI (line 303)

PDERROR_TEXT_OUTSIDE_LI : 56

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

PDERROR_TUTORIAL_IS_OWN_CHILD (line 213)

PDERROR_TUTORIAL_IS_OWN_CHILD : 38

warning triggered when a tutorial lists itself as a child tutorial

PDERROR_TUTORIAL_IS_OWN_GRANDPA (line 218)

PDERROR_TUTORIAL_IS_OWN_GRANDPA : 39

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

PDERROR_TUTORIAL_NOT_FOUND (line 209)

PDERROR_TUTORIAL_NOT_FOUND : 37

warning triggered when a tutorial is referenced

PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND (line 244)

PDERROR_TUTORIAL_SUBSECTION_NOT_FOUND : 44

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

PDERROR_UL_IN_UL (line 392)

PDERROR_UL_IN_UL : 74

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

PDERROR_UNCLOSED_TAG (line 307)

PDERROR_UNCLOSED_TAG : 57

warning triggered when a DocBlock html tag is unclosed

PDERROR_UNDOCUMENTED_ELEMENT (line 408)

PDERROR_UNDOCUMENTED_ELEMENT : 78

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

PDERROR_UNKNOWN_COMMANDLINE (line 162)

PDERROR_UNKNOWN_COMMANDLINE : 27

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 (line 119)

PDERROR_UNKNOWN_TAG : 18

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

PDERROR_UNMATCHED_LIST_TAG (line 190)

PDERROR_UNMATCHED_LIST_TAG : 33

warning triggered when a docblock has an unmatched &lt;ol&gt; or &lt;ul&gt;

PDERROR_UNMATCHED_TUTORIAL_TAG (line 199)

PDERROR_UNMATCHED_TUTORIAL_TAG : 35

warning triggered when a docbook tag is not properly matched

PDERROR_UNTERMINATED_ATTRIB (line 249)

PDERROR_UNTERMINATED_ATTRIB : 45

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

PDERROR_UNTERMINATED_ENTITY (line 339)

PDERROR_UNTERMINATED_ENTITY : 65

warning triggered by an unterminated entity in a tutorial

PDERROR_UNTERMINATED_INLINE_TAG (line 55)

PDERROR_UNTERMINATED_INLINE_TAG : 3

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

addError (line 1110)

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

add an Error

Parameters

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

Info

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

addErrorDie (line 1134)

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

like addError() but exits parsing

Parameters

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

Info

• 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?

addWarning (line 1160)

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

add a Warning

Parameters

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

Info

• 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?