From eb5b6ce4444ab3983818f34092e59b6d58e3b8ed Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Sun, 15 Oct 2017 20:03:24 +0200
Subject: [doc] Add Doxygen API documentation for stats.c and stats_statsd.c

Change-Id: I8e49505f5c19beac90290fdba8821714e8eecd97
---
 src/stats_statsd.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'src/stats_statsd.c')

diff --git a/src/stats_statsd.c b/src/stats_statsd.c
index 6e7be735..5145bf7a 100644
--- a/src/stats_statsd.c
+++ b/src/stats_statsd.c
@@ -1,4 +1,3 @@
-/*! \file stats_statsd.c */
 /*
  * (C) 2015 by Sysmocom s.f.m.c. GmbH
  *
@@ -22,6 +21,10 @@
  *
  */
 
+/*! \addtogroup stats
+ *  @{
+ *  \file stats_statsd.c */
+
 #include "config.h"
 #if !defined(EMBEDDED)
 
@@ -46,6 +49,10 @@ static int osmo_stats_reporter_statsd_send_item(struct osmo_stats_reporter *srep
 	const struct osmo_stat_item_group *statg,
 	const struct osmo_stat_item_desc *desc, int64_t value);
 
+/*! Create a stats_reporter reporting to statsd.  This creates a stats_reporter
+ *  instance which reports the related statistics data to statsd.
+ *  \param[in] name Name of the to-be-created stats_reporter
+ *  \returns stats_reporter on success; NULL on error */
 struct osmo_stats_reporter *osmo_stats_reporter_create_statsd(const char *name)
 {
 	struct osmo_stats_reporter *srep;
@@ -172,3 +179,5 @@ static int osmo_stats_reporter_statsd_send_item(struct osmo_stats_reporter *srep
 		desc->name, value, unit);
 }
 #endif /* !EMBEDDED */
+
+/* @} */
-- 
cgit v1.2.3