Commit 5d0cb6c6 authored by reichenbach's avatar reichenbach
Browse files

[DOC] improved doc in some tests

parent 679d92bb
......@@ -31,6 +31,8 @@
#include "../WSharedObject.h"
/**
* \class WThreadedFunctionTest
*
* Tests the WThreadedFunction class.
*/
class WThreadedFunctionTest : public CxxTest::TestSuite
......@@ -79,6 +81,7 @@ class WThreadedFunctionTest : public CxxTest::TestSuite
/**
* Check if the thread was ordered to stop.
*
* \return true, if the thread was ordered to stop
*/
bool stopped()
......@@ -133,7 +136,8 @@ class WThreadedFunctionTest : public CxxTest::TestSuite
public:
/**
* Test function computation with multiple threads.
* A function computed by multiple threads should correctly set
* its status and compute the correct results.
*/
void testMultipleThreads()
{
......@@ -193,7 +197,7 @@ public:
}
/**
* Test stopping threads.
* Status should be set correctly when threads are ordered to stop.
*/
void testStopThreads()
{
......@@ -213,14 +217,13 @@ public:
}
/**
* Test stop condition.
* The stop condition should be notified correctly.
*/
void testStopCondition()
{
boost::shared_ptr< FuncType > func( new FuncType( 5 ) );
WThreadedFunction< FuncType > f( 6, func );
TS_ASSERT_EQUALS( f.status(), W_THREADS_INITIALIZED );
f.run();
TS_ASSERT_EQUALS( f.status(), W_THREADS_RUNNING );
......@@ -232,7 +235,8 @@ public:
}
/**
* Test exception handling.
* Exceptions should lead to the status beeing changed to W_THREADS_ABORTED. Also,
* exceptions should be forwarded to the exception handler.
*/
void testExceptionHandling()
{
......
......@@ -27,6 +27,8 @@
#include <vector>
#include <cxxtest/TestSuite.h>
#include "../../common/WThreadedFunction.h"
#include "../../common/WLogger.h"
#include "../WDataHandlerEnums.h"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment