|
||||||
| SUMMARY: CHILDREN | PARAMETER | INSTPROC | INSTFILTER | INSTFORWARD | DETAIL: | INSTPROC | |||||
::xotcl::Object
|
+--::xox::Node
|
+--::xounit::Test
|
+--::xounit::Assert
|
+--::xounit::TestCase
|
+--::xounit::Application
An application that reports the documentation coverage for all methods, parameters, and classes in a set of packages.
| Variables | |||
| Name | Default Value | Class | Comment |
currentTestMethod |
::xounit::TestCase | name of the currently running test method. |
|
formatterClass |
::xounit::TestResultsTextFormatter | ::xounit::Application | test results formatter used to display results of application |
name |
Application | ::xounit::Application | the name of the Application |
nodeName |
::xox::Node | ||
packages |
::xounit::RunDocCoverage | packages to report on |
|
prefixes |
::xounit::RunDocCoverage | limit the documentation report to methods that start with these prefixes |
|
result |
::xounit::TestCase | the result for the current run. |
|
results |
"" | ::xounit::Application | failures, errors, and passes from Application execution |
| Methods | |
| Name | Comment |
init {args}
| Initializes and runs the application with the list of packages provided on the command line |
runTestApplication {}
| Main method of the RunDocCoverage application |
| Methods from ::xounit::Application |
printResults, runApplication, runApplicationAndReport,
|
| Methods from ::xotcl::Object |
#, ., ?, ?code, ?methods, ?object, abstract, copy, coverageFilter, defaultmethod, extractConfigureArg, filterappend, garbageCollect, get#, getClean#, hasclass, init, methodTag, mixinappend, move, profileFilter, self, setParameterDefaults, shell, tclcmd, traceFilter,
|
| Instproc Detail |
Initializes and runs the application with the list of packages provided on the command line.
args ::xounit::RunDocCoverage instproc init {args} {
my set packages $args
my runApplication runTestApplication
}
Main method of the RunDocCoverage application. Loads packages. Uses introspection to find all classes, methods, and parameters that do or do not have documentation.
::xounit::RunDocCoverage instproc runTestApplication {} {
my instvar packages prefixes
set aRunner [ ::xounit::TestRunner new ]
set reporter [ ::xounit::DocumentationCoverageReport new ]
$reporter clear
if [ my exists prefixes ] {
$reporter prefixes $prefixes
}
foreach package $packages {
package require "${package}"
puts "Loaded ${package}"
}
$reporter reportPackages $packages
$reporter reportSummary
}