X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FTypeInfo.hh;h=9b507a90c3a74ab9bfca0222c9a125e9ec094cba;hb=9a988902090d28007578e93bffd809f6bd913155;hp=98c3b38e3cb69bb0ebbfbb5059035c011c08613d;hpb=ac6a813d9d99f7add4e13aff7a4bcd314d5604a6;p=senf.git

diff --git a/Utils/TypeInfo.hh b/Utils/TypeInfo.hh
index 98c3b38..9b507a9 100644
--- a/Utils/TypeInfo.hh
+++ b/Utils/TypeInfo.hh
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2006 
+// Copyright (C) 2006
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
@@ -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,8 @@ namespace senf {
 
 // Local Variables:
 // mode: c++
+// fill-column: 100
 // c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
 // End: