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

phpDocumentor

addError()

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

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

clone.inc.php

• CS cleanup - change package to PhpDocumentor

clone5.inc.php

• CS cleanup - change package to PhpDocumentor

parserStringWithInlineTags::Convert()

• CS cleanup - rename to convert for camelCase rule

parserUsedByTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTutorialTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserEntity::Convert()

• CS cleanup - rename to convert for camelCase rule

parserCData::Convert()

• CS cleanup - rename to convert for camelCase rule

parserInheritdocInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserIdInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserLinkInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserSourceInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTutorialInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserTocInlineTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserSeeTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserUsesTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserI::Convert()

• CS cleanup - rename method to convert()

parserReturnTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserList::Convert()

• CS cleanup - rename method to convert()

parserDescVar::Convert()

• CS cleanup - rename method to convert()

parserCode::Convert()

• CS cleanup - rename method to convert()

parserB::Convert()

• CS cleanup - rename method to convert()

parserBr::Convert()

• CS cleanup - rename method to convert()

parserPre::Convert()

• CS cleanup - rename method to convert()

parserKbd::Convert()

• CS cleanup - rename method to convert()

parserNameTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserFileSourceTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserAccessTag::Convert()

• CS cleanup - rename to convert for camelCase rule

parserSamp::Convert()

• CS cleanup - rename method to convert()

parserLinkInlineTag::ConvertPart()

• CS cleanup - rename to convertPart for camelCase rule

debug()

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

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

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.

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

new_phpdoc.php

• CS cleanup - change package to PhpDocumentor

PackagePageElements.inc

• CS cleanup - change package to PhpDocumentor

phpDocumentor_HighlightParser::parse()

• CS cleanup - rename tokenizer_ext constant to uppercase

phpDocumentor_TutorialHighlightParser::parse()

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

Io::parseArgv()

• replace with Console_* ?

parserBase

• CS cleanup - change package to PhpDocumentor

parserData

• CS cleanup - change package to PhpDocumentor

ParserData.inc

• CS cleanup - change package to PhpDocumentor

parserExampleInlineTag::parserExampleInlineTag()

• replace tokenizer_ext constant with TOKENIZER_EXT for CS rule

parserStringWithInlineTags

• CS cleanup - change package to PhpDocumentor

parserXMLDocBookTag::parserXMLDocBookTag()

• 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.inc

• CS cleanup - change package to PhpDocumentor

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_parse_ini_file()

• CS cleanup - rename function to PhpDocumentor_parse_ini_file

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

WordParser

• CS cleanup - change package to PhpDocumentor

WordParser.inc

• CS cleanup - change package to PhpDocumentor

XMLPackagePageParser

• CS cleanup - change package to PhpDocumentor