From 6e61564cc20d0486dfef083306e6bd050330a303 Mon Sep 17 00:00:00 2001
From: meini <meini@meini-desktop.ARBEITSGRUPPE>
Date: Thu, 26 Mar 2009 12:47:41 +0100
Subject: doxygen fix

---
 src/awds/config.h |   66 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 src/config.cc     |   57 +++------------------------------------------
 2 files changed, 70 insertions(+), 53 deletions(-)

diff --git a/src/awds/config.h b/src/awds/config.h
index 5741a2b8e4ad3c1b384959f6174ea0f3102e7f64..fbb94ad3213aee1e1025b3e81237ce5b4b2bd908 100644
--- a/src/awds/config.h
+++ b/src/awds/config.h
@@ -5,6 +5,18 @@
 #include <awds/MarshalStream.h>
 #include "awds/configVariable.h"
 
+/** \defgroup config_mod
+ *   \brief remote configuration module
+ *
+ *  This module provides an remote or local
+ *  opportunity to change registered configuration
+ *  parameters.
+ */
+    /** \brief class for config_mod
+     *  \ingroup config_mod
+     *  The class is handling the remote configuration requests
+     *
+     */
 class Config
 {
 
@@ -26,14 +38,68 @@ public:
 
 	Config();
 	//int remoteConfigAnnounce(char* name,ConfigVariableType cvt,void* thisref,variableGetHandler vgh,variableSetHandler vsh,void* value=NULL);
+ /**
+  * \brief	registerVar
+  *
+  *		This function registers the ConfigVariable at the 
+  *		Configuration class
+  *
+  * \param	cv	the ConfigVariable
+  * \return		statuscode
+  *
+  */
+
 	virtual int registerVar(ConfigVariable* cv);
 	int configAddCommand();
 	int remoteCall(std::string variableName,std::string variableValue,std::string nodeList);
 
 	static int remoteconfig_command_fn(ShellClient &sc, void *data, int argc, char **argv);
+ /**
+  * \brief	requestHandler
+  *
+  *		This Function Handles the incoming requests 
+  *		reads from msIn und writes the outgoing 
+  *		message to msOut
+  *
+  * \param	data	the data send through the SPP module
+  * \param	msIn	the incoming marshalstream
+  * \param	msOut	the outboing marshalstream
+  * \param	src	the origin of the message
+  * \return		statuscode
+  *
+  */
 	static int requestHandler (void *data, ReadMarshalStream*  msIn, WriteMarshalStream* msOut, const awds::NodeId& src);
+ /**
+  * \brief	responseHandler
+  *
+  *		This function handels the responses of the (remote) nodes
+  *
+  * \param	data	the ConfigVariable
+  * \param	msIn	the stream containing the message
+  * \param	src	the Origin of the Message
+  * \return		statuscode
+  *
+  */
 	static int responseHandler (void *data, ReadMarshalStream*  msIn, const awds::NodeId& src);
+ /**
+  * \brief	requestCreator
+  *
+  *		This function builds/marshals the message to be send to the
+  *		awds Nodes
+  *
+  * \param	data	the data to be processed
+  * \param	msOut	the stream to write to
+  *
+  */
 	static void requestCreator (void *data, WriteMarshalStream* msOut);
+ /**
+  * \brief	finishedHandler
+  *
+  *		This function is the callback if the broadcast is complete
+  *
+  * \param	data	the data Provided through the spp call
+  *
+  */
 	static void finishedHandler (void *data);
 
 };
diff --git a/src/config.cc b/src/config.cc
index 555fd24409e96e871e7e8f9f2ab1541759b00b56..84676f35cf32ce15738c455ea52b05e883867b04 100644
--- a/src/config.cc
+++ b/src/config.cc
@@ -29,16 +29,6 @@ Config::Config()
 {
 	requestCount=0;
 }
- /**
-  * \brief	registerVar
-  *
-  *		This function registers the ConfigVariable at the 
-  *		Configuration class
-  *
-  * \param	cv	the ConfigVariable
-  * \return		statuscode
-  *
-  */
 
 int Config::registerVar(ConfigVariable* cv)
 {
@@ -46,16 +36,7 @@ int Config::registerVar(ConfigVariable* cv)
 	return 0;
 }
 
- /**
-  * \brief	requestCreator
-  *
-  *		This function builds/marshals the message to be send to the
-  *		awds Nodes
-  *
-  * \param	data	the data to be processed
-  * \param	msOut	the stream to write to
-  *
-  */
+
 void Config::requestCreator(void *data, WriteMarshalStream* msOut)
 {
 	REP_MAP_OBJ(Config *,config);//get it, but check on USE!
@@ -195,14 +176,7 @@ int Config::remoteconfig_command_fn(ShellClient &sc, void *data, int argc, char
 	return 0;
 }
 
- /**
-  * \brief	finishedHandler
-  *
-  *		This function is the callback if the broadcast is complete
-  *
-  * \param	data	the data Provided through the spp call
-  *
-  */
+
 void Config::finishedHandler (void *data)
 {
 	REP_MAP_OBJ(Config *,config);
@@ -213,17 +187,7 @@ void Config::finishedHandler (void *data)
 				config->shellClient->unblock();
 	}
 }
- /**
-  * \brief	registerVar
-  *
-  *		This function handels the responses of the (remote) nodes
-  *
-  * \param	data	the ConfigVariable
-  * \param	msIn	the stream containing the message
-  * \param	src	the Origin of the Message
-  * \return		statuscode
-  *
-  */
+
 int Config::responseHandler (void *data, ReadMarshalStream*  msIn, const awds::NodeId& src) 
 {
 	REP_MAP_OBJ(Config *,config);//get but we'll check it on USE!
@@ -282,20 +246,7 @@ int Config::responseHandler (void *data, ReadMarshalStream*  msIn, const awds::N
 
 	return CONFIG_VARIABLE_SUCCESS;
 }
- /**
-  * \brief	registerVar
-  *
-  *		This Function Handles the incoming requests 
-  *		reads from msIn und writes the outgoing 
-  *		message to msOut
-  *
-  * \param	data	the data send through the SPP module
-  * \param	msIn	the incoming marshalstream
-  * \param	msOut	the outboing marshalstream
-  * \param	src	the origin of the message
-  * \return		statuscode
-  *
-  */
+
 int Config::requestHandler (void *data, ReadMarshalStream*  msIn, WriteMarshalStream* msOut, const awds::NodeId& src) 
 {
 	REP_MAP_OBJ(Config *,config);
-- 
1.6.2.1


