X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FString.hh;h=5a0c8c06712983e3ac9df04525e8c8d2a374ec44;hb=c505c034e5fdc932c02aa3dc3847a5551011d87e;hp=ed1e65bd0f251cb9375eab6636c7628554d68c31;hpb=9cb871b939efe93e35dd96808d25089399acfc46;p=senf.git

diff --git a/senf/Utils/String.hh b/senf/Utils/String.hh
index ed1e65b..5a0c8c0 100644
--- a/senf/Utils/String.hh
+++ b/senf/Utils/String.hh
@@ -42,6 +42,22 @@ namespace senf {
     template <class ForwardReadableRange>
     std::string stringJoin(ForwardReadableRange const & range, std::string sep);
 
+    /** \brief Get string representation
+
+        Returns the result of streaming the argument into a standard library string-based
+        stream and then out as a std::string object. The conversion is done with
+        <tt>boost::lexical_cast</tt>. The call is equivalent to
+        <pre>
+            boost::lexical_cast<std::string>(t);
+        </pre>
+        \pre
+            <tt>t</tt> must be <i>OutputStreamable</i>,
+                meaning that an <tt>operator\<\<</tt> is defined\n
+            <tt>t</tt> must be <i>CopyConstructible</i>
+
+        \see <a href="http://www.boost.org/doc/libs/release/libs/conversion/lexical_cast.htm">
+            boost::lexical_cast</a>
+     */
     template <class T>
     std::string str(T const & t);