removed some useless spaces; not very important, I know :)

[senf.git] / Utils / TypeInfo.hh

diff --git a/Utils/TypeInfo.hh b/Utils/TypeInfo.hh
index 98c3b38..7244351 100644 (file)
--- a/Utils/TypeInfo.hh
+++ b/Utils/TypeInfo.hh
@@ -1,9 +1,9 @@
 // $Id$
 //
-// Copyright (C) 2006 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Copyright (C) 2006
+// 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
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief TypeInfo public header */
+
 #ifndef HH_TypeInfo_
 #define HH_TypeInfo_ 1
 
@@ -32,7 +35,21 @@
 
 namespace senf {
 
+    /** \brief Try to return readable type for given type_info
+
+        This function will try to return a demangled type name for the
+        given type_info object. If the demangling fails, the possibly
+        mangled name (type->name()) will be returned.
+
+        This function depends on the liberty library provided by the
+        linux binutils or binutils-dev packages. It also depends on an
+        internal header file. If the API should change, this header
+        file (which resides in impl/demangle.h) must be updated from
+        the binutils sources.
 
+        \param[in] type type_info object
+        \returns type name, possibly demangled
+     */
     std::string prettyName(std::type_info const & type);
 
 }
@@ -47,5 +64,10 @@ namespace senf {
 \f
 // Local Variables:
 // mode: c++
+// fill-column: 100
 // c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: