::xounit
Class RunDocCoverage

Heritage:
::xotcl::Object
  |
  +--::xox::Node
        |
        +--::xounit::Test
              |
              +--::xounit::Assert
                    |
                    +--::xounit::TestCase
                          |
                          +--::xounit::Application
Class RunDocCoverage
superclass ::xounit::Application,
An application that reports the documentation
 coverage for all methods, parameters, and classes
 in a set of packages.
Variables
NameDefault ValueClassComment
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
NameComment
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

init

Description:
 Initializes and runs the application with the
 list of packages provided on the command line.
Arguments:
Overrides:
init in ::xotcl::Object
Code:
  ::xounit::RunDocCoverage instproc init {args}  {
   

        my set packages $args
        my runApplication runTestApplication 
    
}

runTestApplication

Description:
 Main method of the RunDocCoverage application.
 Loads packages. Uses introspection to find
 all classes, methods, and parameters that
 do or do not have documentation.
Code:
  ::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 
    
}