Comment changes
authorMikko Rasa <tdb@tdb.fi>
Wed, 16 Jan 2013 16:45:30 +0000 (18:45 +0200)
committerMikko Rasa <tdb@tdb.fi>
Wed, 16 Jan 2013 16:45:47 +0000 (18:45 +0200)
source/strings/lexicalcast.h

index 25e3268126bde5d65cf19dca35d188c96dcebb5e..2ed0621291858c0d0f4d40fb37036fd5decc5700 100644 (file)
@@ -10,7 +10,7 @@
 namespace Msp {
 
 /**
-Thrown for errors in lexical conversions
+Thrown for errors in lexical conversions.
 */
 class lexical_error: public std::runtime_error
 {
@@ -20,6 +20,9 @@ public:
 };
 
 
+/**
+Thrown when the format is unsuitable for the type being converted.
+*/
 class format_mismatch: public lexical_error
 {
 public:
@@ -141,8 +144,9 @@ operator>>(const LexicalConverter &c, T &v)
                throw lexical_error("conversion failure");
 }
 
-// Helper struct to provide partial template specialization
-
+/**
+Helper struct to provide partial template specialization.
+*/
 template<typename T, typename F>
 struct LexicalCast;
 
@@ -180,8 +184,10 @@ struct LexicalCast<std::string, std::string>
        }
 };
 
-// The main interface to the lexical conversion machinery
-
+/** Perform a lexical conversion between a string and another type.  The source
+type can normally be deduced by the compiler, so this can be used just like the
+standard C++ casts.  A format may additionally be specified to force a specific
+interpretation. */
 template<typename T, typename F>
 inline T lexical_cast(const F &v, const Fmt &f = Fmt())
 {