aboutsummaryrefslogtreecommitdiffstats
path: root/src/vty/stats_vty.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 15:17:03 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 15:17:03 +0200
commit8c64825249e46409c982b1e2bf4148f0bc860446 (patch)
treec0167eb38da7d06559d9825a6bebe3f1551218da /src/vty/stats_vty.c
parent7166094a85b88bdf18f19ea1e3a85874c0236748 (diff)
[doc] Don't add libosmovty bits to libosmocore groups
Let's not put files of libosmovty into Doxygen groups of libosmocore, as this seems to confuse Doxygen. Also, some minor updates/fixes of libosmovty documentation. Change-Id: I70e612b8d06aabefe634fcd7861641ffb941d974
Diffstat (limited to 'src/vty/stats_vty.c')
-rw-r--r--src/vty/stats_vty.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c
index 95f04bc..2ccbf66 100644
--- a/src/vty/stats_vty.c
+++ b/src/vty/stats_vty.c
@@ -1,5 +1,3 @@
-/*! \file stats_vty.c
- * OpenBSC stats helper for the VTY. */
/*
* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
* (C) 2009-2014 by Holger Hans Peter Freyther
@@ -43,9 +41,14 @@
#define SHOW_STATS_STR "Show statistical values\n"
-/*! \addtogroup stats
- * @{
+/*! \file stats_vty.c
* VTY interface for statsd / statistic items
+ *
+ * This code allows you to register a couple of VTY commands that
+ * permit configuration of the \ref stats functionality from the VTY.
+ *
+ * Use \ref osmo_stats_vty_add_cmds once at application start-up to
+ * enable related commands.
*/
/* containing version info */
@@ -609,5 +612,3 @@ void osmo_stats_vty_add_cmds()
install_element_ve(&show_stats_asciidoc_table_cmd);
}
-
-/*! @} */