Added some missing documentation for the retry connections.

1 files changed, 12 insertions, 3 deletions

diff --git a/libcmix-network/connect.cpp b/libcmix-network/connect.cpp
index 6f1addf..fb663ac 100644
--- a/libcmix-network/connect.cpp
+++ b/libcmix-network/connect.cpp
@@ -29,11 +29,20 @@ boost::asio::ip::tcp::socket connect(std::string host, std::string port, io_serv
 	throw std::runtime_error("None of the supplied endpoints responded");
 }
 
+/*!
+ * \brief The IterationInfo struct
+ */
 struct IterationInfo {
-	int iteration;
-	boost::asio::ip::tcp::resolver::iterator it;
-	boost::asio::deadline_timer retry_timer;
+	int iteration; ///< the iteration we are currently in starting with 0;
+	boost::asio::ip::tcp::resolver::iterator it; ///< The endpoint iterator.
+	boost::asio::deadline_timer retry_timer; ///< A timer to retry in 3, 6, 12, 24, 48, 96 seconds after subsequent connections failures.
 	
+	/*!
+	 * \brief IterationInfo 
+	 * \param iteration
+	 * \param it
+	 * \param io_service Used to create the deadline_timer
+	 */
 	IterationInfo(int iteration, boost::asio::ip::tcp::resolver::iterator it, boost::asio::io_service& io_service)
 	: iteration(iteration)
 	, it(it)