diff options
| author | Harald Welte <laforge@gnumonks.org> | 2017-06-12 21:44:18 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2017-06-12 21:55:54 +0000 |
| commit | 96e2a00d7a9044d0b1a83909c11d8f24955bc7c8 (patch) | |
| tree | 4bbe6cb49a766df4cdefa9fffd56bb953d51da75 /src/vty/stats_vty.c | |
| parent | 7165880ac279a9d2d7403749f171eb9c60e70657 (diff) | |
update/extend doxygen documentation
It's a pity that even with this patch we still are fare away from having
the whole API documented. However, at least we have a more solid
foundation. Updates not only extend the documentation, but also make
sure it is rendered properly in the doxygen HTML.
Change-Id: I1344bd1a6869fb00de7c1899a8db93bba9bafce3
Diffstat (limited to 'src/vty/stats_vty.c')
| -rw-r--r-- | src/vty/stats_vty.c | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c index c03546b8..af69289f 100644 --- a/src/vty/stats_vty.c +++ b/src/vty/stats_vty.c @@ -41,6 +41,11 @@ #define SHOW_STATS_STR "Show statistical values\n" +/*! \addtogroup stats + * @{ + * \brief VTY interface for statsd / statistic items + */ + /* containing version info */ extern struct host host; @@ -571,6 +576,10 @@ static int config_write_stats(struct vty *vty) return 1; } +/*! \brief Add stats related commands to the VTY + * Call this once during your application initialization if you would + * like to have stats VTY commands enabled. + */ void osmo_stats_vty_add_cmds() { install_element_ve(&show_stats_cmd); @@ -599,3 +608,5 @@ void osmo_stats_vty_add_cmds() install_element_ve(&show_stats_asciidoc_table_cmd); } + +/*! @} */ |