From 7acb30c69b1c10458b37ac403c82e3b98edd9ab1 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Wed, 17 Aug 2011 17:13:48 +0200
Subject: doxygen: Add (partial) VTY API documentation

---
 src/vty/utils.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/vty/utils.c')

diff --git a/src/vty/utils.c b/src/vty/utils.c
index 7797e62d..47b9931f 100644
--- a/src/vty/utils.c
+++ b/src/vty/utils.c
@@ -30,6 +30,17 @@
 
 #include <osmocom/vty/vty.h>
 
+/* \file utils.c */
+
+/*! \addtogroup rate_ctr
+ *  @{
+ */
+
+/*! \brief print a rate counter group to given VTY
+ *  \param[in] vty The VTY to which it should be printed
+ *  \param[in] prefix Any additional log prefix ahead of each line
+ *  \param[in] ctrg Rate counter group to be printed
+ */
 void vty_out_rate_ctr_group(struct vty *vty, const char *prefix,
 			    struct rate_ctr_group *ctrg)
 {
@@ -48,3 +59,5 @@ void vty_out_rate_ctr_group(struct vty *vty, const char *prefix,
 			VTY_NEWLINE);
 	};
 }
+
+/*! }@ */
-- 
cgit v1.2.3