PPI: Missing commit

[senf.git] / Utils / Backtrace.hh

diff --git a/Utils/Backtrace.hh b/Utils/Backtrace.hh
index 4861a3b..f7f8925 100644 (file)
--- a/Utils/Backtrace.hh
+++ b/Utils/Backtrace.hh
@@ -23,8 +23,8 @@
 /** \file
     \brief Backtrace public header */
 
-#ifndef HH_Backtrace_
-#define HH_Backtrace_ 1
+#ifndef HH_SENF_Utils_Backtrace_
+#define HH_SENF_Utils_Backtrace_ 1
 
 // Custom includes
 #include <iostream>
@@ -33,8 +33,27 @@
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
+    /** \defgroup backtraces Backtrace formatting and parsing
 
+        These functions help format and barse backtrace information as returned by the glibc
+        ::backtrace function.
+     */
+
+    /** \brief Format a given backtrace
+
+        This functions will write \a backtrace formatted to \a os. This includes demangling symbol
+        names and interpreting some additional kernel symbols.
+
+        \ingroup backtraces
+     */
     void formatBacktrace(std::ostream & os, void ** backtrace, unsigned numEntries);
+
+    /** \brief Write a backtrace to \a os
+
+        backtrace() will write a backtrace of the current call stack to \a os.
+
+        \ingroup backtraces
+     */
     void backtrace(std::ostream & os, unsigned numEntries);
 
 }