minor fixes for clang++

[senf.git] / senf / Utils / String.hh

diff --git a/senf/Utils/String.hh b/senf/Utils/String.hh
index ed1e65b..0983ccd 100644 (file)
--- a/senf/Utils/String.hh
+++ b/senf/Utils/String.hh
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2008
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
 //
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief String public header */
@@ -30,7 +35,7 @@
 #include <string>
 
 //#include "String.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
@@ -42,6 +47,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);
 
@@ -54,7 +75,7 @@ namespace senf {
     detail::lexical_caster<Target> lexical_cast();
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "String.cci"
 #include "String.ct"
 #include "String.cti"