Skip to content

Commit

Permalink
DummyConnector doxygen tweak
Browse files Browse the repository at this point in the history
svn path=/trunk/yarp2/; revision=6116
  • Loading branch information
paulfitz committed Sep 25, 2007
1 parent 8b42162 commit 2776073
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/libYARP_OS/include/yarp/os/DummyConnector.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ namespace yarp {
}

/**
* \class DummyConnector
* \brief A dummy connection to test yarp::os::Portable implementations
*
* A dummy connection to test yarp::os::Portable implementations.
* This class provides simple means to test read and write methods of the Portable interface.
*
* Psudocode for a test should look something like this:
* - DummyConnector dummy; // create new connection with textmode=false
* - PortableObject object;
* - ... // set object values
* - object.write(dummy.getWriter()); // this will reset the connection and then write to it
* - PortableObject newObject;
* - newObject.read(dummy.getReader()); // this will write from the connection to the new object
* - ... // assert newObject values
* Pseudocode for a test should look something like this:
* \code
* DummyConnector dummy; // create new connection with textmode=false
* PortableObject object;
* ... // set object values
* object.write(dummy.getWriter()); // reset the connection and then write to it
* PortableObject newObject;
* newObject.read(dummy.getReader()); // write from the connection to the new object
* ... // assert newObject values
* \endcode
*
* \sa Portable BufferedConnectionWriter StreamConnectionReader StringInputStream Route
*
* \author Freyr Magnusson
*
*/
Expand Down

0 comments on commit 2776073

Please sign in to comment.