From ba6988bd893eb08c54ffdb144700530e3a683d6e Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Wed, 17 Aug 2011 12:46:48 +0200
Subject: some more doxygen work (include the notion of modules)

---
 include/osmocom/core/socket.h | 44 ++++++-------------------------------------
 1 file changed, 6 insertions(+), 38 deletions(-)

(limited to 'include/osmocom/core/socket.h')

diff --git a/include/osmocom/core/socket.h b/include/osmocom/core/socket.h
index e915f78d..c5288dfc 100644
--- a/include/osmocom/core/socket.h
+++ b/include/osmocom/core/socket.h
@@ -1,6 +1,10 @@
 #ifndef _OSMOCORE_SOCKET_H
 #define _OSMOCORE_SOCKET_H
 
+/*! \defgroup socket Socket convenience functions
+ *  @{
+ */
+
 /*! \file socket.h
  *  \brief Osmocom socket convenience functions
  */
@@ -14,53 +18,17 @@ struct sockaddr;
 #define OSMO_SOCK_F_BIND	(1 << 1)
 #define OSMO_SOCK_F_NONBLOCK	(1 << 2)
 
-/*! \brief Initialize a socket (including bind/connect)
- *  \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
- *  \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
- *  \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
- *  \param[in] host remote host name or IP address in string form
- *  \param[in] port remote port number in host byte order
- *  \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
- *
- * This function creates a new socket of the designated \a family, \a
- * type and \a proto and optionally binds or connects it, depending on
- * the value of \a flags parameter.
- */
 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
 		   const char *host, uint16_t port, unsigned int flags);
 
-/*! \brief Initialize a socket and fill \ref osmo_fd
- *  \param[out] osmocom file descriptor (will be filled in)
- *  \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
- *  \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
- *  \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
- *  \param[in] host remote host name or IP address in string form
- *  \param[in] port remote port number in host byte order
- *  \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
- *
- * This function creates (and optionall binds/connects) a socket using
- * \ref osmo_sock_init, but also fills the \a ofd structure.
- */
 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
 			const char *host, uint16_t port, unsigned int flags);
 
-/*! \brief Initialize a socket and fill \ref sockaddr
- *  \param[out] ss socket address (will be filled in)
- *  \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
- *  \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
- *  \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
- *
- * This function creates (and optionall binds/connects) a socket using
- * \ref osmo_sock_init, but also fills the \a ss structure.
- */
 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
 		      uint8_t proto, unsigned int flags);
 
-/*! \brief Determine if the given address is a local address
- *  \param[in] addr Socket Address
- *  \param[in] addrlen Length of socket address in bytes
- *  \returns 1 if address is local, 0 otherwise.
- */
 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
 
+/*! }@ */
+
 #endif /* _OSMOCORE_SOCKET_H */
-- 
cgit v1.2.3