From de6e4983e7f83794e45af5a70b036ed9f4437ab5 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Thu, 6 Dec 2012 21:25:27 +0100 Subject: add some missing doxygen annotation for libosmocore functions --- src/gsmtap_util.c | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'src/gsmtap_util.c') diff --git a/src/gsmtap_util.c b/src/gsmtap_util.c index ce722da9..77ab0c6e 100644 --- a/src/gsmtap_util.c +++ b/src/gsmtap_util.c @@ -182,7 +182,18 @@ int gsmtap_source_init_fd(const char *host, uint16_t port) OSMO_SOCK_F_CONNECT); } -/*! \brief Add a local sink to an existing GSMTAP source and return fd */ +/*! \brief Add a local sink to an existing GSMTAP source and return fd + * \param[in] gsmtap_fd file descriptor of the gsmtap socket + * \returns file descriptor of locally bound receive socket + * + * In case the GSMTAP socket is connected to a local destination + * IP/port, this function creates a corresponding receiving socket + * bound to that destination IP + port. + * + * In case the gsmtap socket is not connected to a local IP/port, or + * creation of the receiving socket fails, a negative error code is + * returned. + */ int gsmtap_source_add_sink_fd(int gsmtap_fd) { struct sockaddr_storage ss; @@ -360,3 +371,5 @@ struct gsmtap_inst *gsmtap_source_init(const char *host, uint16_t port, } #endif /* HAVE_SYS_SOCKET_H */ + +/*! @} */ -- cgit v1.2.3