aboutsummaryrefslogtreecommitdiffstats
path: root/src/stats_statsd.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-15 20:03:24 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 14:18:56 +0200
commiteb5b6ce4444ab3983818f34092e59b6d58e3b8ed (patch)
treec0e5a7438fb028440e99bc8127e9790b799c0a67 /src/stats_statsd.c
parent17bbaa324b9873a965634c60f5696ebd57b5d6a1 (diff)
[doc] Add Doxygen API documentation for stats.c and stats_statsd.c
Diffstat (limited to 'src/stats_statsd.c')
-rw-r--r--src/stats_statsd.c11
1 files changed, 10 insertions, 1 deletions
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 */
+
+/* @} */