X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FBacktrace.hh;h=03f47412e40e7e834670b2624a35f8b385170425;hb=8488a803a9e1dfa293af161eb271503990d6fdd3;hp=b2d39d75a2f56df8bffc85742213452d936d325b;hpb=d5ba3d7759212c90a5f4a25baf0dc38e290c3b64;p=senf.git

diff --git a/Utils/Backtrace.hh b/Utils/Backtrace.hh
index b2d39d7..03f4741 100644
--- a/Utils/Backtrace.hh
+++ b/Utils/Backtrace.hh
@@ -33,9 +33,29 @@
 ///////////////////////////////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);
+
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////