From 18fc465b7ff9818338fa8eb350ee4f20c9acb2c8 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Wed, 17 Aug 2011 14:14:17 +0200
Subject: doxygen documentation for logging framework

---
 src/logging_syslog.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src/logging_syslog.c')

diff --git a/src/logging_syslog.c b/src/logging_syslog.c
index 4f043b1d..b07b7fe6 100644
--- a/src/logging_syslog.c
+++ b/src/logging_syslog.c
@@ -19,6 +19,12 @@
  *
  */
 
+/*! \addtogroup logging
+ *  @{
+ */
+
+/*! \file logging_syslog.c */
+
 #include "../config.h"
 
 #ifdef HAVE_SYSLOG_H
@@ -57,6 +63,12 @@ static void _syslog_output(struct log_target *target,
 	syslog(logp2syslog_level(level), "%s", log);
 }
 
+/*! \brief Create a new logging target for syslog logging
+ *  \param[in] ident syslog string identifier
+ *  \param[in] option syslog options
+ *  \param[in] facility syslog facility
+ *  \returns Log target in case of success, NULL in case of error
+ */
 struct log_target *log_target_create_syslog(const char *ident, int option,
 					    int facility)
 {
@@ -76,3 +88,5 @@ struct log_target *log_target_create_syslog(const char *ident, int option,
 }
 
 #endif /* HAVE_SYSLOG_H */
+
+/* }@ */
-- 
cgit v1.2.3