From 4a7d07a2e0c3650711dda9f3d694d333eb3765de Mon Sep 17 00:00:00 2001
From: Dirk Ziegelmeier <dirk@ziegelmeier.net>
Date: Tue, 26 Jul 2016 22:06:54 +0200
Subject: [PATCH] Document netdb API, add socket functions implemented by lwip
 to documentation, just for reference

---
 src/api/netdb.c            |  6 ++++++
 src/include/lwip/netdb.h   |  4 ++++
 src/include/lwip/pbuf.h    |  4 +++-
 src/include/lwip/sockets.h | 26 ++++++++++++++++++++++++++
 4 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/src/api/netdb.c b/src/api/netdb.c
index 6aeab9a5..f9d63d46 100644
--- a/src/api/netdb.c
+++ b/src/api/netdb.c
@@ -33,6 +33,12 @@
  *
  */
 
+
+/**
+ * @defgroup netdbapi NETDB API
+ * @ingroup socket
+ */
+
 #include "lwip/netdb.h"
 
 #if LWIP_DNS && LWIP_SOCKET
diff --git a/src/include/lwip/netdb.h b/src/include/lwip/netdb.h
index 8da12c28..21688c65 100644
--- a/src/include/lwip/netdb.h
+++ b/src/include/lwip/netdb.h
@@ -130,10 +130,14 @@ int lwip_getaddrinfo(const char *nodename,
        struct addrinfo **res);
 
 #if LWIP_COMPAT_SOCKETS
+/** @ingroup netdbapi */
 #define gethostbyname(name) lwip_gethostbyname(name)
+/** @ingroup netdbapi */
 #define gethostbyname_r(name, ret, buf, buflen, result, h_errnop) \
        lwip_gethostbyname_r(name, ret, buf, buflen, result, h_errnop)
+/** @ingroup netdbapi */
 #define freeaddrinfo(addrinfo) lwip_freeaddrinfo(addrinfo)
+/** @ingroup netdbapi */
 #define getaddrinfo(nodname, servname, hints, res) \
        lwip_getaddrinfo(nodname, servname, hints, res)
 #endif /* LWIP_COMPAT_SOCKETS */
diff --git a/src/include/lwip/pbuf.h b/src/include/lwip/pbuf.h
index fa31bc68..4561f62d 100644
--- a/src/include/lwip/pbuf.h
+++ b/src/include/lwip/pbuf.h
@@ -73,7 +73,9 @@ typedef enum {
   PBUF_RAW
 } pbuf_layer;
 
-/** Enumeration of pbuf types
+/**
+ * @ingroup pbuf
+ * Enumeration of pbuf types
  */
 typedef enum {
   /** pbuf data is stored in RAM, used for TX mostly, struct pbuf and its payload
diff --git a/src/include/lwip/sockets.h b/src/include/lwip/sockets.h
index 5a21011c..20ba6293 100644
--- a/src/include/lwip/sockets.h
+++ b/src/include/lwip/sockets.h
@@ -507,39 +507,65 @@ int lwip_fcntl(int s, int cmd, int val);
 
 #if LWIP_COMPAT_SOCKETS
 #if LWIP_COMPAT_SOCKETS != 2
+/** @ingroup socket */
 #define accept(s,addr,addrlen)                    lwip_accept(s,addr,addrlen)
+/** @ingroup socket */
 #define bind(s,name,namelen)                      lwip_bind(s,name,namelen)
+/** @ingroup socket */
 #define shutdown(s,how)                           lwip_shutdown(s,how)
+/** @ingroup socket */
 #define getpeername(s,name,namelen)               lwip_getpeername(s,name,namelen)
+/** @ingroup socket */
 #define getsockname(s,name,namelen)               lwip_getsockname(s,name,namelen)
+/** @ingroup socket */
 #define setsockopt(s,level,optname,opval,optlen)  lwip_setsockopt(s,level,optname,opval,optlen)
+/** @ingroup socket */
 #define getsockopt(s,level,optname,opval,optlen)  lwip_getsockopt(s,level,optname,opval,optlen)
+/** @ingroup socket */
 #define closesocket(s)                            lwip_close(s)
+/** @ingroup socket */
 #define connect(s,name,namelen)                   lwip_connect(s,name,namelen)
+/** @ingroup socket */
 #define listen(s,backlog)                         lwip_listen(s,backlog)
+/** @ingroup socket */
 #define recv(s,mem,len,flags)                     lwip_recv(s,mem,len,flags)
+/** @ingroup socket */
 #define recvfrom(s,mem,len,flags,from,fromlen)    lwip_recvfrom(s,mem,len,flags,from,fromlen)
+/** @ingroup socket */
 #define send(s,dataptr,size,flags)                lwip_send(s,dataptr,size,flags)
+/** @ingroup socket */
 #define sendmsg(s,message,flags)                  lwip_sendmsg(s,message,flags)
+/** @ingroup socket */
 #define sendto(s,dataptr,size,flags,to,tolen)     lwip_sendto(s,dataptr,size,flags,to,tolen)
+/** @ingroup socket */
 #define socket(domain,type,protocol)              lwip_socket(domain,type,protocol)
+/** @ingroup socket */
 #define select(maxfdp1,readset,writeset,exceptset,timeout)     lwip_select(maxfdp1,readset,writeset,exceptset,timeout)
+/** @ingroup socket */
 #define ioctlsocket(s,cmd,argp)                   lwip_ioctl(s,cmd,argp)
 
 #if LWIP_POSIX_SOCKETS_IO_NAMES
+/** @ingroup socket */
 #define read(s,mem,len)                           lwip_read(s,mem,len)
+/** @ingroup socket */
 #define write(s,dataptr,len)                      lwip_write(s,dataptr,len)
+/** @ingroup socket */
 #define writev(s,iov,iovcnt)                      lwip_writev(s,iov,iovcnt)
+/** @ingroup socket */
 #define close(s)                                  lwip_close(s)
+/** @ingroup socket */
 #define fcntl(s,cmd,val)                          lwip_fcntl(s,cmd,val)
+/** @ingroup socket */
 #define ioctl(s,cmd,argp)                         lwip_ioctl(s,cmd,argp)
 #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
 #endif /* LWIP_COMPAT_SOCKETS != 2 */
 
 #if LWIP_IPV4 && LWIP_IPV6
+/** @ingroup socket */
 #define inet_ntop(af,src,dst,size) \
     (((af) == AF_INET6) ? ip6addr_ntoa_r((const ip6_addr_t*)(src),(dst),(size)) \
      : (((af) == AF_INET) ? ip4addr_ntoa_r((const ip4_addr_t*)(src),(dst),(size)) : NULL))
+/** @ingroup socket */
 #define inet_pton(af,src,dst) \
     (((af) == AF_INET6) ? ip6addr_aton((src),(ip6_addr_t*)(dst)) \
      : (((af) == AF_INET) ? ip4addr_aton((src),(ip4_addr_t*)(dst)) : 0))