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/fsm_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/fsm_vty.c')
| -rw-r--r-- | src/vty/fsm_vty.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/vty/fsm_vty.c b/src/vty/fsm_vty.c index 422de9d9..3824fe8c 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 @@ void osmo_fsm_vty_add_cmds(void) install_element_ve(&show_fsm_inst_cmd); install_element_ve(&show_fsm_insts_cmd); } + +/*! @} */ |