From: Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Date: Sat, 25 Feb 2012 16:07:06 +0000 (-0200)
Subject: Documentation: documenting the parsing function.
X-Git-Tag: v1.5~1^2~31
X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=72e9614232ff8f600a3a8bd405a30eded47bbd60;p=pingcheck

Documentation: documenting the parsing function.
---

diff --git a/src/host/pingprotocol.cpp b/src/host/pingprotocol.cpp
index 9522045..038da96 100644
--- a/src/host/pingprotocol.cpp
+++ b/src/host/pingprotocol.cpp
@@ -29,6 +29,13 @@ using namespace std;
 
 static map<string, PingProtocol> protocol_string_map;
 
+/**
+ * @brief Transform the @a protocol_string into a @c PingProtocol.
+ *
+ * @param protocol_string The string to be parsed.
+ *
+ * @return The @c PingProtocol corresponding to the @a protocol_string.
+ */
 PingProtocol get_ping_protocol_from_string( const string & protocol_string )
 {
     BOOST_ASSERT( !protocol_string.empty() );