Changeset 104 for trunk

Timestamp:

10/19/10 14:52:12 (19 months ago)

Author:

mgalloy

Message:

Updating comment headers.

Location:

trunk/src

Files:

• assert.pro (modified) (1 diff)
• mgunit_wrapper.pro (modified) (1 diff)
• mgutclirunner__define.pro (modified) (4 diffs)
• mgutcompoundrunner__define.pro (modified) (2 diffs)
• mgutguirunner__define.pro (modified) (2 diffs)
• mguthtmlrunner__define.pro (modified) (2 diffs)
• mgutjunitrunner__define.pro (modified) (2 diffs)
• mguttestcase__define.pro (modified) (5 diffs)
• mguttestsuite__define.pro (modified) (1 diff)
• mgutxmlrunner__define.pro (modified) (3 diffs)

trunk/src/assert.pro

@@ -2 +2 @@
 
 ;+
-; Raises an error if the given condition is not met. Uses logical_predicate
+; Raises an error if the given condition is not met. Uses `logical_predicate`
 ; to determine truth of condition: so zero or null values are false, anything
 ; else is true. Be careful of conditions like::
 ;     
 ;    assert, not file_test(filename)
+;
+; which use bitwise operators (the above is always false).
 ;
 ; :Params: 

trunk/src/mgunit_wrapper.pro

@@ -2 +2 @@
 
 ;+
-; Command line wrapper for mgunit. This routine is made to be called from the
-; mgunit shell script.
+; Command line wrapper for `mgunit`. This routine is made to be called from 
+; the `mgunit` shell script.
 ;-
 pro mgunit_wrapper

trunk/src/mgutclirunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The MGutCliRunner displays the results in the output log or in a 
+; runner. The `MGutCliRunner` displays the results in the output log or in a 
 ; log file.
 ;-
@@ -184 +184 @@
 ; :Keywords:
 ;    _extra : in, optional, type=keywords
-;       keywords to MG_ANSICODE i.e. RED or GREEN
+;       keywords to `MG_ANSICODE`, i.e., `RED` or `GREEN`
 ;-
 pro mgutclirunner::_print, lun, text, _extra=e
@@ -239 +239 @@
 ;    filename : in, optional, type=string 
 ;       if present, output is sent to that file, otherwise output is sent to 
-;       stdout
+;       `stdout`
 ;    color : in, optional, type=boolean
 ;       set to print color output
@@ -281 +281 @@
 ;    space
 ;       byte value of the space character
+;    isTty
+;       whether the `mgunit` believes it is running in a TTY terminal or not
 ;-
 pro mgutclirunner__define

trunk/src/mgutcompoundrunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The MGutHTMLRunner displays the results in the output HTML file.
+; runner. The `MGutCompoundRunner` allows results to be sent to multiple
+; test runners, e.g., to the display and to a file.
 ;-
 
@@ -178 +179 @@
 ;    filename : in, optional, type=string
 ;       if present, output is sent that file, otherwise output is sent to 
-;       stdout
+;       `stdout`
 ;-
 function mgutcompoundrunner::init, filename=filename, _extra=e

trunk/src/mgutguirunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The mgutguirunner displays the results in the output log or in a 
-; log file.
+; runner. The `MGutGUIRunner` displays the results in an interactive GUI.
 ;-
 
@@ -324 +323 @@
 ;    tlb
 ;       top-level base of GUI
+;    toolbar
+;       base widget containing toolbar items
 ;    text
+;       text widget displaying results
 ;    continued
+;    cleared
+;    indent
+;    space
 ;-
 pro mgutguirunner__define

trunk/src/mguthtmlrunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The MGutHTMLRunner displays the results in the output HTML file.
+; runner. The `MGutHTMLRunner` displays the results in the output HTML file.
 ;-
 
@@ -210 +210 @@
 ;    filename : in, optional, type=string
 ;       if present, output is sent that file, otherwise output is sent to 
-;       stdout
+;       `stdout`
 ;    color : in, optional, type=boolean
 ;       unused for MGutHtmlRunner

trunk/src/mgutjunitrunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The mgutjunitrunner displays the results in the output HTML file.
+; runner. The `MGutJUnitRunner` displays the results in the output XML file. 
+; For example, a test that normally runs like::
+;
+;    IDL> mgunit, 'gpuradon_ut'        
+;    "All tests" test suite starting (1 test suite/case, 2 tests)
+;       "gpuradon_ut" test case starting (2 tests)
+;          test_basic_backprojection: passed (0.158287 seconds)
+;          test_basic_forward: failed "incorrect result" (0.005014 seconds)
+;       Results: 1 / 2 tests passed, 0 skipped
+;    Results: 1 / 2 tests passed, 0 skipped
+;
+; With `MGutJUnitRunner`, it would produce output like::
+;
+;    IDL> mgunit, 'gpuradon_ut', /junit        
+;    <testsuites name="All tests">
+;      <testsuite name="gpuradon_ut">
+;        <testcase name="test_basic_backprojection">
+;        </testcase>
+;        <testcase name="test_basic_forward">
+;          <failure>incorrect result</failure>
+;        </testcase>
+;      </testsuite>
+;    </testsuites>
 ;-
 
@@ -202 +224 @@
 ;    filename : in, optional, type=string
 ;       if present, output is sent that file, otherwise output is sent to 
-;       stdout
+;       `stdout`
 ;    color : in, optional, type=boolean
 ;       unused for mgutjunitrunner

trunk/src/mguttestcase__define.pro

@@ -2 +2 @@
 
 ;+
-; Subclass MGtestCase to actually write tests. Any function method whose name 
-; starts with "test" will be considered a test. Tests are executed and results 
-; are reported to the test runner object.
+; Subclass `MGutTestCase` to actually write tests. Any function method whose 
+; name starts with "test" will be considered a test. Tests are executed and 
+; results are reported to the test runner object.
 ;-
 
@@ -36 +36 @@
 
 ;+
-; This is a safe place to actually run a single test. Any errors that occur are
-; assumed to be from the test and recorded as a failure for it.
+; This is a safe place to actually run a single test. Any errors that occur 
+; are assumed to be from the test and recorded as a failure for it.
 ;
 ; :Returns: 
@@ -138 +138 @@
   
 ;+
-; Run the tests for this class (i.e. methods with names that start with "test").
+; Run the tests for this class (i.e. methods with names that start with 
+; "test").
 ;-
 pro mguttestcase::run
@@ -304 +305 @@
 ; :Keywords:
 ;    test_runner : in, required, type=object
-;       subclass of MGutTestRunner
+;       subclass of `MGutTestRunner`
 ;-
 function mguttestcase::init, test_runner=testRunner
@@ -325 +326 @@
 ; :Fields:
 ;    testRunner 
-;       subclass of MGtestRunner
+;       subclass of `MGtestRunner`
 ;    testnames 
 ;       pointer to string array of method names that start with "test"

trunk/src/mguttestsuite__define.pro

@@ -2 +2 @@
 
 ;+
-; Test suites are containers for test cases. Either subclass MGutTestSuite and 
-; add test suites/test cases in its init method or create a MGutTestSuite and 
-; use the add method to add test suites/cases.
+; Test suites are containers for test cases. Either subclass `MGutTestSuite` 
+; and add test suites/test cases in its `init` method or create an 
+; `MGutTestSuite` and use the `add` method to add test suites/cases.
 ;-
 

trunk/src/mgutxmlrunner__define.pro

@@ -3 +3 @@
 ;+
 ; Results for tests, test cases, and test suites are reported to the test 
-; runner. The mgutxmlrunner displays the results in the output HTML file.
+; runner. The `MGutXMLRunner` displays the results in the output XML file.
 ;-
 
@@ -164 +164 @@
 ; :Keywords:
 ;    _extra : in, optional, type=keywords
-;       keywords to MG_ANSICODE i.e. RED or GREEN
+;       keywords to `MG_ANSICODE`, i.e., `RED` or `GREEN`
 ;-
 pro mgutxmlrunner::_print, lun, text, level=level, _extra=e
@@ -194 +194 @@
 ;    filename : in, optional, type=string
 ;       if present, output is sent that file, otherwise output is sent to 
-;       stdout
+;       `stdout`
 ;    color : in, optional, type=boolean
-;       unused for mgutxmlrunner
+;       unused for `MGutXMLRunner`
 ;    _extra : in, optional, type=keywords
-;       keywords to MGutTestRunner::init
+;       keywords to `MGutTestRunner::init`
 ;-
 function mgutxmlrunner::init, filename=filename, color=color, _extra=e