From 72e9614232ff8f600a3a8bd405a30eded47bbd60 Mon Sep 17 00:00:00 2001 From: Guilherme Maciel Ferreira Date: Sat, 25 Feb 2012 14:07:06 -0200 Subject: [PATCH] Documentation: documenting the parsing function. --- src/host/pingprotocol.cpp | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-) 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 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() ); -- 1.7.1