From 8140c77d7d0dd26e0be6dc4410445a6c2b6ebd59 Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Tue, 26 Jul 2016 18:26:58 +0200 Subject: [PATCH] Document Socket API in doxygen module style --- src/api/sockets.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/api/sockets.c b/src/api/sockets.c index 1695d8f0..e0b072fe 100644 --- a/src/api/sockets.c +++ b/src/api/sockets.c @@ -38,6 +38,14 @@ * */ +/** + * @defgroup socket Socket API + * BSD-style socket API.\n + * Thread-safe, to be called from non-TCPIP threads only.\n + * Can be activated by defining LWIP_SOCKET to 1.\n + * Header is in posix/sys/socket.h\b + */ + #include "lwip/opt.h" #if LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */