Documentation: documenting the parsing function.

diff --git a/src/host/pingprotocol.cpp b/src/host/pingprotocol.cpp
index 9522045..038da96 100644 (file)
--- 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() );