[lmi-commits] [4934] Improve documentation

[Greg Chicares]

Revision: 4934
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=4934
Author:   chicares
Date:     2010-05-09 12:21:40 +0000 (Sun, 09 May 2010)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/map_lookup.hpp

Modified: lmi/trunk/map_lookup.hpp
===================================================================
--- lmi/trunk/map_lookup.hpp    2010-05-09 10:35:18 UTC (rev 4933)
+++ lmi/trunk/map_lookup.hpp    2010-05-09 12:21:40 UTC (rev 4934)
@@ -30,9 +30,11 @@
 #include <sstream>
 #include <stdexcept>
 
-// The reason why this isn't called 'operator[]() const' is discussed
-// in the thread beginning here:
-//   http://groups.google.com/group/comp.std.c++/msg/c1df492f65f29c5a
+/// Retrieve a value from a std::map; throw if key not found.
+///
+/// The reason why this isn't called 'operator[]() const' is discussed
+/// in the thread beginning here:
+///   http://groups.google.com/group/comp.std.c++/msg/c1df492f65f29c5a
 
 template<typename map_t>
 typename map_t::mapped_type const& map_lookup
@@ -51,6 +53,7 @@
             ;
         throw std::runtime_error(oss.str());
         }
+
     return i->second;
 }