Todo List

Converters

XMLDocBookpeardoc2Converter::endClass()

• move class summary into an array to be written out at the end of parsing each package

CHMdefaultConverter::Output()

• use to directly call html help compiler hhc.exe

PDFdefaultConverter

• Implement links to conflicts/inheritance

XMLDocBookConverter

• indexes for other DocBook converters not based on peardoc
• templates

phpDocumentor

abstractLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

ErrorTracker::addError()

• CS Cleanup - do I need to add $data to the method signature?

addError()

• CS Cleanup - do I need to add $data to the method signature?

addErrorDie()

• CS Cleanup - do I need to add $data to the method signature?

ErrorTracker::addErrorReturn()

• CS Cleanup - do I need to add $data to the method signature?

addWarning()

• CS Cleanup - do I need to add $data to the method signature?

ErrorTracker::addWarning()

• CS Cleanup - do I need to add $data to the method signature?

phpDocumentor_TutorialHighlightParser::checkEventPop()

• CS cleanup - PHPCS needs to recognize docblock template tags

phpDocumentor_TutorialHighlightParser::checkEventPush()

• CS cleanup - PHPCS needs to recognize docblock template tags

Classes

• CS cleanup - change package to PhpDocumentor

Classes.inc

• CS cleanup - change package to PhpDocumentor

classLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

clone.inc.php

• CS cleanup - change package to PhpDocumentor

clone5.inc.php

• CS cleanup - change package to PhpDocumentor

common.inc.php

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename constant to TOKENIZER_EXT

constLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserLinkInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTutorialTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserSamp::Convert()

• CS cleanup - rename method to convert()

parserSeeTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserAccessTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserUsesTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserUsedByTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserIdInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserInheritdocInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserFileSourceTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserPre::Convert()

• CS cleanup - rename method to convert()

parserTocInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserB::Convert()

• CS cleanup - rename method to convert()

parserReturnTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserCData::Convert()

• CS cleanup - rename to convert for camelCase rule

parserStringWithInlineTags::Convert()

• CS cleanup - rename to convert for camelCase rule

parserEntity::Convert()

• CS cleanup - rename to convert for camelCase rule

parserBr::Convert()

• CS cleanup - rename method to convert()

parserCode::Convert()

• CS cleanup - rename method to convert()

parserNameTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserList::Convert()

• CS cleanup - rename method to convert()

parserKbd::Convert()

• CS cleanup - rename method to convert()

parserTutorialInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserDescVar::Convert()

• CS cleanup - rename method to convert()

parserI::Convert()

• CS cleanup - rename method to convert()

parserSourceInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserLinkInlineTag::ConvertPart()

• CS cleanup - rename to convertPart for camelCase rule

parserFileSourceTag::ConvertSource()

• CS cleanup - rename to convertSource for camelCase rule
• what's up with all the "return" statements? can they _all_ be removed?

parserExampleTag::ConvertSource()

• CS cleanup - rename to convertSource for camelCase rule
• what's up with all the "return" statements? can they _all_ be removed?

debug()

• CS Cleanup - can't avoid "prefixed by package" error

defineLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

DescHTML.inc

• CS cleanup - change package to PhpDocumentor

DocBlockTags.inc

• CS cleanup - change package to PhpDocumentor

Errors.inc

• CS cleanup - change package to PhpDocumentor

ErrorTracker

• CS cleanup - change package to PhpDocumentor

EventStack

• CS cleanup - change package to PhpDocumentor

EventStack.inc

• CS cleanup - change package to PhpDocumentor

find_phpdoc.php

• CS cleanup - change package to PhpDocumentor
• CS cleanup - change subpackage to Setup

functionLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

ProceduralPages::getPathInfo()

• figure out what &$c is and update the param tag

parserPage::getSourceLocation()

• determine if the str_replace in the 'pear/' ELSE branch should be removed (see Documentation/tests/bug1574043.php). It does NOT exist in the similar function parserClass->getSourceLocation() in ParserElements.inc.

globalLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserTag::HandleEvent()

• CS cleanup - rename to handleEvent for camelCase rule

HighlightParser.inc

• CS cleanup - change package to PhpDocumentor

Classes::Inherit()

• CS Cleanup - rename to "inherit" for CamelCaps naming standard

InlineTags.inc

• CS cleanup - change package to PhpDocumentor

LinkClasses.inc

• CS cleanup - change package to PhpDocumentor

methodLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

new_phpdoc.php

• CS cleanup - change package to PhpDocumentor

PackagePageElements.inc

• CS cleanup - change package to PhpDocumentor

pageLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

phpDocumentor_TutorialHighlightParser::parse()

• CS cleanup - unable to get function signature below 85char wide

phpDocumentor_HighlightParser::parse()

• CS cleanup - rename tokenizer_ext constant to uppercase

Io::parseArgv()

• replace with Console_* ?

parserAccessTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserB

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserB

parserBase

• CS cleanup - change package to PhpDocumentor

parserBr

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserBr

parserCData

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserCode

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserCode

parserData

• CS cleanup - change package to PhpDocumentor

ParserData.inc

• CS cleanup - change package to PhpDocumentor

parserDescVar

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserDescVar

parserEntity

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserExampleInlineTag::parserExampleInlineTag()

• replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

parserExampleInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserExampleTag::parserExampleTag()

• CS cleanup - rename constant to TOKENIZER_EXT
• does this "x = y = z = false" still work as expected in PHP5?

parserExampleTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserFileSourceTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserI

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserI

parserIdInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserInheritdocInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserKbd

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserKbd

parserLicenseTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserLinkInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserLinkTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserList

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserList

parserMethodTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserNameTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserPage

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserParamTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserPre

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserPre

parserPropertyReadTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserPropertyTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserPropertyWriteTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserReturnTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserSamp

• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename class to ParserSamp

parserSeeTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserSourceInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserStaticvarTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserStringWithInlineTags

• CS cleanup - change package to PhpDocumentor

parserTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserTocInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserTutorialInlineTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserTutorialTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserUsedByTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserUsesTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserVarTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

parserXMLDocBookTag::parserXMLDocBookTag()

• CS cleanup - rename to parserXmlDocBookTag for camelCase rule

parserXMLDocBookTag

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor
• CS cleanup - rename to parserXmlDocBookTag for camelCase rule

PDERROR_CLASS_PARENT_NOT_FOUND

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

PDERROR_GLOBAL_NOT_FOUND

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

PDERROR_MALFORMED_GLOBAL_TAG

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

PDERROR_MULTIPLE_GLOBAL_TAGS

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

PDERROR_NEED_WHITESPACE

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

PDERROR_PACKAGEOUTPUT_DELETES_PARENT_FILE

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

PDERROR_UNKNOWN_COMMANDLINE

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

phpdoc.inc

• CS cleanup - change package to PhpDocumentor

phpdoc.php

• CS cleanup - change package to PhpDocumentor

phpDocumentorTParser

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

phpDocumentorTParser.inc

• CS cleanup - change package to PhpDocumentor

phpDocumentorTWordParser

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

phpDocumentorTWordParser.inc

• CS cleanup - change package to PhpDocumentor
• CS cleanup - PHPCS needs to ignore CVS Id length

phpDocumentor_clone()

• CS cleanup - rename function to PhpDocumentor_clone

phpDocumentor_ConfigFileList()

• CS cleanup - rename function to PhpDocumentor_ConfigFileList

phpDocumentor_get_class()

• CS cleanup - rename function to PhpDocumentor_get_class

phpDocumentor_HighlightParser

• CS cleanup - change class name to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

phpDocumentor_HighlightWordParser

• CS cleanup - change class name to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

phpDocumentor_parse_ini_file()

• CS cleanup - rename function to PhpDocumentor_parse_ini_file

phpDocumentor_TutorialHighlightParser

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

ProceduralPages

• CS cleanup - change package to PhpDocumentor

ProceduralPages.inc

• CS cleanup - change package to PhpDocumentor

Publisher

• CS cleanup - change package to PhpDocumentor

Publisher.inc

• CS cleanup - change package to PhpDocumentor

RecordError

• CS cleanup - change package to PhpDocumentor

RecordWarning::RecordWarning()

• CS Cleanup - do I need to add $data to the method signature? to sprintf based on the error number

RecordWarning

• CS cleanup - change package to PhpDocumentor

phpDocumentor_setup::setMemoryLimit()

• recognize "K" and "G" in memory_limit settings, rather than just "M"

parserInlineTag::Strlen()

• CS cleanup - rename to strLen for camelCase rule

Publisher::subscribe()

• CS Cleanup - there's no way I can get the &$object desc under 85 chars

TutorialHighlightParser.inc

• CS cleanup - change package to PhpDocumentor
• CS cleanup - PHPCS needs to ignore CVS Id length

tutorialLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

varLink

• CS cleanup - change classname to PhpDocumentor_*
• CS cleanup - change package to PhpDocumentor

WordParser

• CS cleanup - change package to PhpDocumentor

WordParser.inc

• CS cleanup - change package to PhpDocumentor

XMLPackagePageParser

• CS cleanup - change package to PhpDocumentor

XMLpackagePageParser.inc

• CS cleanup - change package to PhpDocumentor
• CS cleanup - PHPCS needs to ignore CVS Id length

tests

ParserClassGetSourceLocationTests.php

• research possibility of refactoring ParserClass->getSourceLocation() and ParserPage->getSourceLocation() into a common method... also, there might be more occurrences of similar getSourceLocation() methods in other classes.

ParserPageGetSourceLocationTests.php

• research possibility of refactoring ParserClass->getSourceLocation() and ParserPage->getSourceLocation() into a common method... also, there might be more occurrences of similar getSourceLocation() methods in other classes.

tests_ParserPageGetSourceLocationTests::testWhenNonPearLocationSetAndPearizeTrue()

• Revisit this test... I think it highlights a bug in the getSourceLocation method. Compare it with the same test in bug1574047.php against similar method parserClass->getSourceLocation().

tests_ParserPageGetSourceLocationTests::testWhenNonPearLocationSetIncludingDotsAndPearizeTrue()

• Revisit this test... I think it highlights a bug in the getSourceLocation method. Compare it with the same test in bug1574047.php against similar method parserClass->getSourceLocation().

tests_ParserPageGetSourceLocationTests::testWhenNonPearRelativeLocationSetAndPearizeTrue()

• Revisit this test... I think it highlights a bug in the getSourceLocation method. Compare it with the same test in bug1574047.php against similar method parserClass->getSourceLocation().

XML_Beautifier

PHPDoc_XML_Beautifier_Renderer_Plain

• automatically create <![CDATA[ ]]> sections
• option to specify inline tags
• option to specify treatment of whitespac in data sections