Updated documentation and bumped Cmix to Version 1.0

1 files changed, 19 insertions, 0 deletions

diff --git a/libcmix-common/performanceclient.hpp b/libcmix-common/performanceclient.hpp
index cb9afb1..7c4e501 100644
--- a/libcmix-common/performanceclient.hpp
+++ b/libcmix-common/performanceclient.hpp
@@ -4,13 +4,32 @@
 
 #include <boost/timer/timer.hpp>
 
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The PerformanceClient class: Cpu timing class to keep track of performance.
+ */
 class PerformanceClient
 {
 	std::string node_name;
 	Sender sender;
 	boost::timer::cpu_timer timer;	
 public:
+
+	/*!
+	 * \brief PerformanceClient Cpu timing class to keep track of performance.
+	 * \param name The name of the client this will result in seperate files on the server side.
+	 * \param io_service the io_service it should run under.
+	 * \param host The host on which the statsd is running.
+	 * \param port The port on which the statsd is running.
+	 */
 	PerformanceClient(std::string name, boost::asio::io_service& io_service, std::string host, std::string port);
 	
+	/*!
+	 * \brief send Send a timestamp message to the server.
+	 * \param column What event (or column)
+	 */
 	void send(std::string column);
 };
\ No newline at end of file