diff options
author | Harald Welte <laforge@gnumonks.org> | 2011-08-17 17:13:48 +0200 |
---|---|---|
committer | Harald Welte <laforge@gnumonks.org> | 2011-08-17 17:14:12 +0200 |
commit | 7acb30c69b1c10458b37ac403c82e3b98edd9ab1 (patch) | |
tree | 0baea1ee03ebec8b7c0840c3afc2ddcd2dbc1611 /include/osmocom/vty/telnet_interface.h | |
parent | 47379ca95bd926759d34abcdd1b4b0465fd448c0 (diff) |
doxygen: Add (partial) VTY API documentation
Diffstat (limited to 'include/osmocom/vty/telnet_interface.h')
-rw-r--r-- | include/osmocom/vty/telnet_interface.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/include/osmocom/vty/telnet_interface.h b/include/osmocom/vty/telnet_interface.h index 1d8055e7..c776f51c 100644 --- a/include/osmocom/vty/telnet_interface.h +++ b/include/osmocom/vty/telnet_interface.h @@ -26,15 +26,28 @@ #include <osmocom/vty/vty.h> +/*! \addtogroup vty + * @{ + */ + +/*! \file telnet_interface.h */ + +/*! \brief A telnet connection */ struct telnet_connection { + /*! \brief linked list header for internal management */ struct llist_head entry; + /*! \brief private data pointer passed through */ void *priv; + /*! \brief filedsecriptor (socket ) */ struct osmo_fd fd; + /*! \brief VTY instance associated with telnet connection */ struct vty *vty; + /*! \brief logging target associated with this telnet connection */ struct log_target *dbg; }; - int telnet_init(void *tall_ctx, void *priv, int port); -#endif +/*! }@ */ + +#endif /* TELNET_INTERFACE_H */ |