aboutsummaryrefslogtreecommitdiffstats
path: root/src/vty/logging_vty.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-06-12 21:44:18 +0200
committerHarald Welte <laforge@gnumonks.org>2017-06-12 21:55:54 +0000
commit96e2a00d7a9044d0b1a83909c11d8f24955bc7c8 (patch)
tree4bbe6cb49a766df4cdefa9fffd56bb953d51da75 /src/vty/logging_vty.c
parent7165880ac279a9d2d7403749f171eb9c60e70657 (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/logging_vty.c')
-rw-r--r--src/vty/logging_vty.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/vty/logging_vty.c b/src/vty/logging_vty.c
index 7ec212e7..8c8a3235 100644
--- a/src/vty/logging_vty.c
+++ b/src/vty/logging_vty.c
@@ -39,6 +39,16 @@
#define LOG_STR "Configure logging sub-system\n"
+/*! \addtogroup logging
+ * @{
+ * \brief Configuration of logging from VTY
+ *
+ * This module implements functions that permit configuration of
+ * the libosmocore logging framework from VTY commands. This applies
+ * both to logging to the VTY (telnet sessions), as well as logging to
+ * other targets, such as sysslog, file, gsmtap, ...
+ */
+
extern const struct log_info *osmo_log_info;
static void _vty_output(struct log_target *tgt,
@@ -778,3 +788,5 @@ void logging_vty_add_cmds()
#endif
install_element(CONFIG_NODE, &cfg_log_gsmtap_cmd);
}
+
+/* @} */