QA_Peardoc_Coverage
[ class tree: QA_Peardoc_Coverage ] [ index: QA_Peardoc_Coverage ] [ all elements ]

Element index for package QA_Peardoc_Coverage

[ a ] [ c ] [ d ] [ e ] [ g ] [ l ] [ m ] [ q ] [ r ] [ s ] [ _ ]

_

__construct
in file Coverage.php, method QA_Peardoc_Coverage::__construct()
    Creates a new coverage checker instance.
top

a

$arBadFiles
in file ClassList.php, variable QA_Peardoc_Coverage_Classlist::$arBadFiles
$arCategoryAssociation
in file Coverage.php, variable QA_Peardoc_Coverage::$arCategoryAssociation
    Special category associations.
$arCategoryDocNames
in file Coverage.php, variable QA_Peardoc_Coverage::$arCategoryDocNames
    List with package category name => Doc category name associations.
$arIgnoredPackages
in file Coverage.php, variable QA_Peardoc_Coverage::$arIgnoredPackages
    Lowercase package names that should be ignored.
$arLevels
in file DeveloperList.php, variable QA_Peardoc_Coverage_Renderer_DeveloperList::$arLevels
top

c

$colDocumented
in file SimplePackageList.php, variable QA_Peardoc_Coverage_Renderer_SimplePackageList::$colDocumented
$colDocumented
in file DeveloperList.php, variable QA_Peardoc_Coverage_Renderer_DeveloperList::$colDocumented
$colDocumented
in file ExtendetPackageList.php, variable QA_Peardoc_Coverage_Renderer_ExtendetPackageList::$colDocumented
$colMethodDocumented
in file ExtendetPackageList.php, variable QA_Peardoc_Coverage_Renderer_ExtendetPackageList::$colMethodDocumented
$colMethodNotDocumented
in file ExtendetPackageList.php, variable QA_Peardoc_Coverage_Renderer_ExtendetPackageList::$colMethodNotDocumented
$colMethodPartlyDocumented
in file ExtendetPackageList.php, variable QA_Peardoc_Coverage_Renderer_ExtendetPackageList::$colMethodPartlyDocumented
$colNotDocumented
in file ExtendetPackageList.php, variable QA_Peardoc_Coverage_Renderer_ExtendetPackageList::$colNotDocumented
$colNotDocumented
in file DeveloperList.php, variable QA_Peardoc_Coverage_Renderer_DeveloperList::$colNotDocumented
$colNotDocumented
in file SimplePackageList.php, variable QA_Peardoc_Coverage_Renderer_SimplePackageList::$colNotDocumented
compareMaintainers
in file DeveloperList.php, method QA_Peardoc_Coverage_Renderer_DeveloperList::compareMaintainers()
    Compares two maintainer arrays for sorting
ClassList.php
procedural page ClassList.php
Coverage.php
procedural page Coverage.php
top

d

displayMissing.php
procedural page displayMissing.php
DeveloperList.php
procedural page DeveloperList.php
top

e

existsId
in file Coverage.php, method QA_Peardoc_Coverage::existsId()
    Checks if an id exists in the manual
ExtendetPackageList.php
procedural page ExtendetPackageList.php
top

g

generateCoverage
in file Coverage.php, method QA_Peardoc_Coverage::generateCoverage()
    Generates the coverage analysis
getCategory
in file Coverage.php, method QA_Peardoc_Coverage::getCategory()
    Returns the category name for the package.
getClassnamesFromFilename
in file ClassList.php, method QA_Peardoc_Coverage_Classlist::getClassnamesFromFilename()
    Tries to find classnames in a given file
getColor
in file DeveloperList.php, method QA_Peardoc_Coverage_Renderer_DeveloperList::getColor()
    Returns the color code matching the number.
getColor
in file SimplePackageList.php, method QA_Peardoc_Coverage_Renderer_SimplePackageList::getColor()
    Returns the color code matching the number.
getColor
in file ExtendetPackageList.php, method QA_Peardoc_Coverage_Renderer_ExtendetPackageList::getColor()
    Returns the color code matching the number.
getDocUrl
in file SimplePackageList.php, method QA_Peardoc_Coverage_Renderer_SimplePackageList::getDocUrl()
    Returns the manual url (deep link) for the given documentation id.
getDocUrl
in file ExtendetPackageList.php, method QA_Peardoc_Coverage_Renderer_ExtendetPackageList::getDocUrl()
    Returns the manual url (deep link) for the given documentation id.
getFileList
in file ClassList.php, method QA_Peardoc_Coverage_Classlist::getFileList()
    Returns a list of .php files in the given directory and its subdirectories.
getMaintainers
in file DeveloperList.php, method QA_Peardoc_Coverage_Renderer_DeveloperList::getMaintainers()
    Returns an array of package maintainer usernames, their email address, real name and the packages maintained by them. Also lists which packages are not docced, and which are.
getMethodDocState
in file ExtendetPackageList.php, method QA_Peardoc_Coverage_Renderer_ExtendetPackageList::getMethodDocState()
    Generates the class/method coverage html
getMethods
in file MethodList.php, method QA_Peardoc_Coverage_MethodList::getMethods()
    Returns a class => method list for the classes defined in the given filename.
getPackageCoverage
in file Coverage.php, method QA_Peardoc_Coverage::getPackageCoverage()
    Creates the documentation coverage for the given package.
getPackageDocId
in file Coverage.php, method QA_Peardoc_Coverage::getPackageDocId()
    Returns the ID of the XML node of the package in the pear documentation.
getPackageList
in file Coverage.php, method QA_Peardoc_Coverage::getPackageList()
    Returns a list of packages and their paths
getPackageMaintainers
in file DeveloperList.php, method QA_Peardoc_Coverage_Renderer_DeveloperList::getPackageMaintainers()
    Reads the package maintainers from a package.xml (v1 and v2) file.
genData.php
procedural page genData.php
genDeveloperStats.php
procedural page genDeveloperStats.php
genExtendetStats.php
procedural page genExtendetStats.php
genMissingDocsPerDeveloper.php
procedural page genMissingDocsPerDeveloper.php
genSimpleStats.php
procedural page genSimpleStats.php
gtk2VardumpData.php
procedural page gtk2VardumpData.php
top

l

loadXmlDocument
in file Coverage.php, method QA_Peardoc_Coverage::loadXmlDocument()
    Loads the given xml file into a DOM document.
top

m

MethodList.php
procedural page MethodList.php
MissingDocsPerDeveloper.php
procedural page MissingDocsPerDeveloper.php
top

q

QA_Peardoc_Coverage
in file Coverage.php, class QA_Peardoc_Coverage
    Simple peardoc coverage analysis.
QA_Peardoc_Coverage_Classlist
in file ClassList.php, class QA_Peardoc_Coverage_Classlist
    Class and method list for a given package directory.
QA_Peardoc_Coverage_MethodList
in file MethodList.php, class QA_Peardoc_Coverage_MethodList
    Returns a method list for the class defined in the given filename.
QA_Peardoc_Coverage_Renderer
in file Renderer.php, class QA_Peardoc_Coverage_Renderer
    Renderer interface.
QA_Peardoc_Coverage_Renderer_DeveloperList
in file DeveloperList.php, class QA_Peardoc_Coverage_Renderer_DeveloperList
    Renders a list with developers, the number of packages they maintain and the documented/undocumented ratio
QA_Peardoc_Coverage_Renderer_ExtendetPackageList
in file ExtendetPackageList.php, class QA_Peardoc_Coverage_Renderer_ExtendetPackageList
    Renders the coverage result in an extendet list of packages with its documented state, and the classes with their methods.
QA_Peardoc_Coverage_Renderer_MissingDocsPerDeveloper
in file MissingDocsPerDeveloper.php, class QA_Peardoc_Coverage_Renderer_MissingDocsPerDeveloper
    Creates the serialized output of an array containing the email address of a developer and his undocumented packages.
QA_Peardoc_Coverage_Renderer_SimplePackageList
in file SimplePackageList.php, class QA_Peardoc_Coverage_Renderer_SimplePackageList
    Renders the coverage result in a simple list of packages with their documentation state.
top

r

Renderer.php
procedural page Renderer.php
render
in file Renderer.php, method QA_Peardoc_Coverage_Renderer::render()
    This method gets the $arDoc array with coverage analysis, and returns a string with the rendered coverage.
render
in file MissingDocsPerDeveloper.php, method QA_Peardoc_Coverage_Renderer_MissingDocsPerDeveloper::render()
    Renders the given coverage array and returns the HTML.
render
in file DeveloperList.php, method QA_Peardoc_Coverage_Renderer_DeveloperList::render()
    Renders the given coverage array and returns the HTML.
render
in file ExtendetPackageList.php, method QA_Peardoc_Coverage_Renderer_ExtendetPackageList::render()
    Renders the given coverage array and returns the HTML.
render
in file SimplePackageList.php, method QA_Peardoc_Coverage_Renderer_SimplePackageList::render()
    Renders the given coverage array and returns the HTML.
renderCoverage
in file Coverage.php, method QA_Peardoc_Coverage::renderCoverage()
    Renders the coverage analysis into a viewable format.
top

s

sendMails.php
procedural page sendMails.php
SimplePackageList.php
procedural page SimplePackageList.php
top

Documentation generated on Sat, 27 Oct 2007 11:00:08 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.