From a523d14096f767a736dac30d551ca1d1f0359347 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Wed, 17 Aug 2011 16:09:19 +0200
Subject: doxygen: document panic.[ch]

---
 include/osmocom/core/panic.h | 11 ++++++++++-
 src/panic.c                  |  8 ++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/include/osmocom/core/panic.h b/include/osmocom/core/panic.h
index c28a8440..fd5cf208 100644
--- a/include/osmocom/core/panic.h
+++ b/include/osmocom/core/panic.h
@@ -1,11 +1,20 @@
 #ifndef OSMOCORE_PANIC_H
 #define OSMOCORE_PANIC_H
 
+/*! \addtogroup utils
+ *  @{
+ */
+
+/*! \file panic.h */
+
 #include <stdarg.h>
 
+/*! \brief panic handler callback function type */
 typedef void (*osmo_panic_handler_t)(const char *fmt, va_list args);
 
 extern void osmo_panic(const char *fmt, ...);
 extern void osmo_set_panic_handler(osmo_panic_handler_t h);
 
-#endif
+/*! @} */
+
+#endif /* OSMOCORE_PANIC_H */
diff --git a/src/panic.c b/src/panic.c
index d4452264..be644ff1 100644
--- a/src/panic.c
+++ b/src/panic.c
@@ -20,6 +20,12 @@
  *
  */
 
+/*! \addtogroup utils
+ *  @{
+ */
+
+/*! \file panic.c */
+
 #include <osmocom/gsm/gsm_utils.h>
 #include <osmocom/core/panic.h>
 #include <osmocom/core/backtrace.h>
@@ -52,6 +58,7 @@ static void osmo_panic_default(const char *fmt, va_list args)
 #endif
 
 
+/*! \brief Terminate the current program with a panic */
 void osmo_panic(const char *fmt, ...)
 {
 	va_list args;
@@ -67,6 +74,7 @@ void osmo_panic(const char *fmt, ...)
 }
  
 
+/*! \brief Set the panic handler */
 void osmo_set_panic_handler(osmo_panic_handler_t h)
 {
 	osmo_panic_handler = h;
-- 
cgit v1.2.3