summaryrefslogtreecommitdiff
path: root/include/cppunit/Test.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/cppunit/Test.h')
-rw-r--r--include/cppunit/Test.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/cppunit/Test.h b/include/cppunit/Test.h
index dde4958..0ed98f9 100644
--- a/include/cppunit/Test.h
+++ b/include/cppunit/Test.h
@@ -64,6 +64,8 @@ public:
/*! \brief Finds the test with the specified name and its parents test.
* \param testName Name of the test to find.
+ * \param testPath If the test is found, then all the tests traversed to access
+ * \a test are added to \a testPath, including \c this and \a test.
* \return \c true if a test with the specified name is found, \c false otherwise.
*/
virtual bool findTestPath( const std::string &testName,
@@ -71,6 +73,8 @@ public:
/*! \brief Finds the specified test and its parents test.
* \param test Test to find.
+ * \param testPath If the test is found, then all the tests traversed to access
+ * \a test are added to \a testPath, including \c this and \a test.
* \return \c true if the specified test is found, \c false otherwise.
*/
virtual bool findTestPath( const Test *test,
@@ -93,7 +97,7 @@ public:
protected:
/*! Throws an exception if the specified index is invalid.
- * \param Zero base index of a child test.
+ * \param index Zero base index of a child test.
* \exception std::out_of_range is \a index is < 0 or >= getChildTestCount().
*/
virtual void checkIsValidIndex( int index ) const;