Include all lwIP files in doxygen documentation

src/apps/httpd/httpd.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * LWIP HTTP server implementation
+ */
+
 /*
  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_mib2_icmp.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) ICMP objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_interfaces.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) INTERFACES objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_ip.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) IP objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_snmp.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) SNMP objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_system.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) SYSTEM objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_tcp.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) TCP objects and functions.
  */
 
 /*

src/apps/snmp/snmp_mib2_udp.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * Management Information Base II (RFC1213) objects and functions.
+ * Management Information Base II (RFC1213) UDP objects and functions.
  */
 
 /*

src/apps/snmp/snmp_msg.c

@@ -1,6 +1,6 @@
 /**
  * @file
- * SNMP input message processing (RFC1157).
+ * SNMP message processing (RFC1157).
  */
 
 /*

src/apps/snmp/snmp_msg.h

@@ -1,6 +1,6 @@
 /**
  * @file
- * SNMP Agent message handling structures.
+ * SNMP Agent message handling structures (internal API, do not use in client code).
  */
 
 /*

src/apps/snmp/snmp_pbuf_stream.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP pbuf stream wrapper implementation (internal API, do not use in client code).
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_pbuf_stream.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP pbuf stream wrapper (internal API, do not use in client code).
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_scalar.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP scalar node support implementation.
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_table.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP table support implementation.
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_threadsync.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP thread synchronization implementation.
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmp_traps.c

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMPv1 traps implementation.
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/apps/snmp/snmpv3_priv.h

@@ -1,6 +1,6 @@
 /**
  * @file
- * Additional SNMPv3 functionality RFC3414 and RFC3826.
+ * Additional SNMPv3 functionality RFC3414 and RFC3826 (internal API, do not use in client code).
  */
 
 /*

src/include/lwip/api.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * netconn API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/httpd.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * HTTP server
+ */
+
 /*
  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/httpd_opts.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * HTTP server options list
+ */
+
 /*
  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/lwiperf.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IPERF implementation
+ */
+
 /*
  * Copyright (c) 2014 Simon Goldschmidt
  * All rights reserved.

src/include/lwip/apps/netbiosns.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * NETBIOS name service responder
+ */
+
 /*
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:

src/include/lwip/apps/netbiosns_opts.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * NETBIOS name service responder options
+ */
+
 /*
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:

src/include/lwip/apps/snmp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP server main API - start and basic configuration
+ */
+
 /*
  * Copyright (c) 2001, 2002 Leon Woestenberg <leon.woestenberg@axon.tv>
  * Copyright (c) 2001, 2002 Axon Digital Design B.V., The Netherlands.

src/include/lwip/apps/snmp_core.h

@@ -1,8 +1,6 @@
 /**
  * @file
- * Generic MIB tree structures.
- *
- * @todo namespace prefixes
+ * SNMP core API for implementing MIBs
  */
 
 /*

src/include/lwip/apps/snmp_mib2.h

@@ -1,7 +1,6 @@
 /**
  * @file
- * MIB2 callback functions called from throughout the stack to integrate a MIB2
- * into lwIP (together with MIB2_STATS).
+ * SNMP MIB2 API
  */
 
 /*

src/include/lwip/apps/snmp_opts.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP server options list
+ */
+
 /*
  * Copyright (c) 2015 Dirk Ziegelmeier
  * All rights reserved.

src/include/lwip/apps/snmp_scalar.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP server MIB API to implement scalar nodes
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/snmp_table.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP server MIB API to implement table nodes
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/snmp_threadsync.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNMP server MIB API to implement thread synchronization
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/apps/sntp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNTP client API
+ */
+
 /*
  * Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt
  * All rights reserved.

src/include/lwip/apps/sntp_opts.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * SNTP client options list
+ */
+
 /*
  * Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt
  * All rights reserved.

src/include/lwip/arch.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Support for different processor and compiler architectures
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/debug.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Debug messages infrastructure
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/def.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * various utility macros
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/dhcp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * DHCP client API
+ */
+
 /*
  * Copyright (c) 2001-2004 Leon Woestenberg <leon.woestenberg@gmx.net>
  * Copyright (c) 2001-2004 Axon Digital Design B.V., The Netherlands.

src/include/lwip/dns.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * DNS API
+ */
+
 /**
  * lwip DNS resolver header file.
 

src/include/lwip/err.h

@@ -1,3 +1,7 @@
+/**
+ * @file
+ * lwIP Error codes
+ */
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/icmp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * ICMP API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/igmp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IGMP API
+ */
+
 /*
  * Copyright (c) 2002 CITEL Technologies Ltd.
  * All rights reserved.

src/include/lwip/inet_chksum.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IP checksum calculation functions
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/init.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * lwIP initialization API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/ip.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IP API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/ip4.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IPv4 API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/ip4_addr.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IPv4 address API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/ip_addr.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IP address API (common IPv4 and IPv6)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/ip_frag.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * IP fragmentation/reassembly
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/mem.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Heap API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/memp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Memory pool API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/netbuf.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * netbuf API (for netconn API)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/netdb.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * NETDB API (sockets)
+ */
+
 /*
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:

src/include/lwip/netif.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * netif API (to be used from TCPIP thread)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/netifapi.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * netif API (to be used from non-TCPIP threads)
+ */
+
 /*
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:

src/include/lwip/pbuf.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * pbuf API
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.
@@ -68,6 +73,8 @@ typedef enum {
   PBUF_RAW
 } pbuf_layer;
 
+/** Enumeration of pbuf types
+ */
 typedef enum {
   /** pbuf data is stored in RAM, used for TX mostly, struct pbuf and its payload
       are allocated in one piece of contiguous memory (so the first payload byte
@@ -105,6 +112,8 @@ typedef enum {
 /** indicates this pbuf includes a TCP FIN flag */
 #define PBUF_FLAG_TCP_FIN   0x20U
 
+/** Main payload buffer struct
+ */
 struct pbuf {
   /** next pbuf in singly linked pbuf chain */
   struct pbuf *next;

src/include/lwip/priv/api_msg.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * netconn API lwIP internal implementations (do not use in application code)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/priv/memp_priv.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * memory pools lwIP internal implementations (do not use in application code)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/priv/memp_std.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * lwIP internal memory pools (do not use in application code)
+ */
+
 /*
  * SETUP: Make sure we define everything we will need.
  *

src/include/lwip/priv/tcp_priv.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * TCP internal implementations (do not use in application code)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/priv/tcpip_priv.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * TCPIP API internal implementations (do not use in application code)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/raw.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * raw API (to be used from TCPIP thread)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/snmp.h

@@ -1,7 +1,6 @@
 /**
  * @file
- * MIB2 callback functions called from throughout the stack to integrate a MIB2
- * into lwIP (together with MIB2_STATS).
+ * SNMP support API for implementing netifs and statitics for MIB2
  */
 
 /*

src/include/lwip/sockets.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Socket API (to be used from non-TCPIP threads)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/stats.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Statistics API (to be used from TCPIP thread)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/sys.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * OS abstraction layer
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/tcp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * TCP API (to be used from TCPIP thread)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/tcpip.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Functions to sync with TCPIP thread
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/timers.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Timer implementations
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/lwip/udp.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * UDP API (to be used from TCPIP thread)
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/include/netif/etharp.h

@@ -1,3 +1,10 @@
+/**
+ * @file
+ * Ethernet output function - handles OUTGOING ethernet level traffic, implements
+ * ARP resolving.
+ * To be used in most low-level netif implementations
+ */
+
 /*
  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
  * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>

src/include/netif/ethernet.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Ethernet input function - handles INCOMING ethernet level traffic
+ * To be used in most low-level netif implementations
+ */
+
 /*
  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
  * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>

src/include/netif/lowpan6_opts.h

@@ -1,3 +1,8 @@
+/**
+ * @file
+ * 6LowPAN options list
+ */
+
 /*
  * Copyright (c) 2015 Inico Technologies Ltd.
  * All rights reserved.

src/include/netif/slipif.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * SLIP netif API
+ */
+
 /*
  * Copyright (c) 2001, Swedish Institute of Computer Science.
  * All rights reserved.