From 27760739d8d57ea0a7d8ea138ddc485dfcb976d6 Mon Sep 17 00:00:00 2001 From: Paul Fitzpatrick Date: Tue, 25 Sep 2007 16:38:54 +0000 Subject: [PATCH] DummyConnector doxygen tweak svn path=/trunk/yarp2/; revision=6116 --- .../include/yarp/os/DummyConnector.h | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/libYARP_OS/include/yarp/os/DummyConnector.h b/src/libYARP_OS/include/yarp/os/DummyConnector.h index 4bba7b7453c..8b7aaad7778 100644 --- a/src/libYARP_OS/include/yarp/os/DummyConnector.h +++ b/src/libYARP_OS/include/yarp/os/DummyConnector.h @@ -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 * */