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
diff --git a/src/vty/fsm_vty.c b/src/vty/fsm_vty.c
index 422de9d..3824fe8 100644
--- a/src/vty/fsm_vty.c
+++ b/src/vty/fsm_vty.c
@@ -33,6 +33,16 @@
#include <osmocom/core/logging.h>
#include <osmocom/core/linuxlist.h>
+/*! \addtogroup fsm
+ * @{
+ * \brief VTY interface for Osmocom FSM
+ *
+ * This is code implementing generic VTY access to Osmocom FSMs from
+ * libosmocore. This means that any application can expose all state
+ * of all instances of all registered FSM classes by calling a single
+ * command during startup: \ref osmo_fsm_vty_add_cmds
+ */
+
/* we don't want to add this to a public header file; this is simply
* exported by libosmocore and used by libmsomvty but not for public
* consumption. */
@@ -175,3 +185,5 @@
install_element_ve(&show_fsm_inst_cmd);
install_element_ve(&show_fsm_insts_cmd);
}
+
+/*! @} */