diff --git a/src/apps/httpd/httpd.c b/src/apps/httpd/httpd.c index 10603a5b..1cb8adbb 100644 --- a/src/apps/httpd/httpd.c +++ b/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. diff --git a/src/apps/snmp/snmp_mib2_icmp.c b/src/apps/snmp/snmp_mib2_icmp.c index 5d7efbb9..7b807194 100644 --- a/src/apps/snmp/snmp_mib2_icmp.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_interfaces.c b/src/apps/snmp/snmp_mib2_interfaces.c index 29b67427..257c0bd9 100644 --- a/src/apps/snmp/snmp_mib2_interfaces.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_ip.c b/src/apps/snmp/snmp_mib2_ip.c index 395362e7..7f766637 100644 --- a/src/apps/snmp/snmp_mib2_ip.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_snmp.c b/src/apps/snmp/snmp_mib2_snmp.c index bd132436..d0405ce4 100644 --- a/src/apps/snmp/snmp_mib2_snmp.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_system.c b/src/apps/snmp/snmp_mib2_system.c index 6f89f8e2..b67f0129 100644 --- a/src/apps/snmp/snmp_mib2_system.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_tcp.c b/src/apps/snmp/snmp_mib2_tcp.c index 3e365b71..90993844 100644 --- a/src/apps/snmp/snmp_mib2_tcp.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_mib2_udp.c b/src/apps/snmp/snmp_mib2_udp.c index 67d185ea..ce6f7f7b 100644 --- a/src/apps/snmp/snmp_mib2_udp.c +++ b/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. */ /* diff --git a/src/apps/snmp/snmp_msg.c b/src/apps/snmp/snmp_msg.c index 6cca814e..fe4cb122 100644 --- a/src/apps/snmp/snmp_msg.c +++ b/src/apps/snmp/snmp_msg.c @@ -1,6 +1,6 @@ /** * @file - * SNMP input message processing (RFC1157). + * SNMP message processing (RFC1157). */ /* diff --git a/src/apps/snmp/snmp_msg.h b/src/apps/snmp/snmp_msg.h index 73fdf663..514c7afb 100644 --- a/src/apps/snmp/snmp_msg.h +++ b/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). */ /* diff --git a/src/apps/snmp/snmp_pbuf_stream.c b/src/apps/snmp/snmp_pbuf_stream.c index 6bb10fee..04b9c14c 100644 --- a/src/apps/snmp/snmp_pbuf_stream.c +++ b/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. diff --git a/src/apps/snmp/snmp_pbuf_stream.h b/src/apps/snmp/snmp_pbuf_stream.h index 07e00ccc..9778de77 100644 --- a/src/apps/snmp/snmp_pbuf_stream.h +++ b/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. diff --git a/src/apps/snmp/snmp_scalar.c b/src/apps/snmp/snmp_scalar.c index 811d2016..9e583313 100644 --- a/src/apps/snmp/snmp_scalar.c +++ b/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. diff --git a/src/apps/snmp/snmp_table.c b/src/apps/snmp/snmp_table.c index bf7ca9d1..67108c19 100644 --- a/src/apps/snmp/snmp_table.c +++ b/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. diff --git a/src/apps/snmp/snmp_threadsync.c b/src/apps/snmp/snmp_threadsync.c index 9a41f677..d26bd276 100644 --- a/src/apps/snmp/snmp_threadsync.c +++ b/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. diff --git a/src/apps/snmp/snmp_traps.c b/src/apps/snmp/snmp_traps.c index fe584e0e..3da2dca8 100644 --- a/src/apps/snmp/snmp_traps.c +++ b/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. diff --git a/src/apps/snmp/snmpv3_priv.h b/src/apps/snmp/snmpv3_priv.h index f12f95c6..b87666da 100644 --- a/src/apps/snmp/snmpv3_priv.h +++ b/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). */ /* diff --git a/src/include/lwip/api.h b/src/include/lwip/api.h index a7a7f907..4975d490 100644 --- a/src/include/lwip/api.h +++ b/src/include/lwip/api.h @@ -1,3 +1,8 @@ +/** + * @file + * netconn API + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/apps/httpd.h b/src/include/lwip/apps/httpd.h index a739c117..3a82a181 100644 --- a/src/include/lwip/apps/httpd.h +++ b/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. diff --git a/src/include/lwip/apps/httpd_opts.h b/src/include/lwip/apps/httpd_opts.h index 871ced45..148a406e 100644 --- a/src/include/lwip/apps/httpd_opts.h +++ b/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. diff --git a/src/include/lwip/apps/lwiperf.h b/src/include/lwip/apps/lwiperf.h index 6a7fb4d1..746c8247 100644 --- a/src/include/lwip/apps/lwiperf.h +++ b/src/include/lwip/apps/lwiperf.h @@ -1,3 +1,8 @@ +/** + * @file + * IPERF implementation + */ + /* * Copyright (c) 2014 Simon Goldschmidt * All rights reserved. diff --git a/src/include/lwip/apps/netbiosns.h b/src/include/lwip/apps/netbiosns.h index 1999388a..7ff85581 100644 --- a/src/include/lwip/apps/netbiosns.h +++ b/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: diff --git a/src/include/lwip/apps/netbiosns_opts.h b/src/include/lwip/apps/netbiosns_opts.h index e8ba536b..9fe35022 100644 --- a/src/include/lwip/apps/netbiosns_opts.h +++ b/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: diff --git a/src/include/lwip/apps/snmp.h b/src/include/lwip/apps/snmp.h index 52f8484f..2383bcd8 100644 --- a/src/include/lwip/apps/snmp.h +++ b/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 * Copyright (c) 2001, 2002 Axon Digital Design B.V., The Netherlands. diff --git a/src/include/lwip/apps/snmp_core.h b/src/include/lwip/apps/snmp_core.h index 807a7a41..6e67a9a4 100644 --- a/src/include/lwip/apps/snmp_core.h +++ b/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 */ /* diff --git a/src/include/lwip/apps/snmp_mib2.h b/src/include/lwip/apps/snmp_mib2.h index 312d0c07..2f4a6893 100644 --- a/src/include/lwip/apps/snmp_mib2.h +++ b/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 */ /* diff --git a/src/include/lwip/apps/snmp_opts.h b/src/include/lwip/apps/snmp_opts.h index 12275851..ff76d2ab 100644 --- a/src/include/lwip/apps/snmp_opts.h +++ b/src/include/lwip/apps/snmp_opts.h @@ -1,3 +1,8 @@ +/** + * @file + * SNMP server options list + */ + /* * Copyright (c) 2015 Dirk Ziegelmeier * All rights reserved. diff --git a/src/include/lwip/apps/snmp_scalar.h b/src/include/lwip/apps/snmp_scalar.h index a230c969..e80c72fe 100644 --- a/src/include/lwip/apps/snmp_scalar.h +++ b/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. diff --git a/src/include/lwip/apps/snmp_table.h b/src/include/lwip/apps/snmp_table.h index b4780867..8c3070cc 100644 --- a/src/include/lwip/apps/snmp_table.h +++ b/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. diff --git a/src/include/lwip/apps/snmp_threadsync.h b/src/include/lwip/apps/snmp_threadsync.h index d45417aa..0b5e2786 100644 --- a/src/include/lwip/apps/snmp_threadsync.h +++ b/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. diff --git a/src/include/lwip/apps/sntp.h b/src/include/lwip/apps/sntp.h index 0dcc5578..40df9cc5 100644 --- a/src/include/lwip/apps/sntp.h +++ b/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. diff --git a/src/include/lwip/apps/sntp_opts.h b/src/include/lwip/apps/sntp_opts.h index 7eafb230..b4871d79 100644 --- a/src/include/lwip/apps/sntp_opts.h +++ b/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. diff --git a/src/include/lwip/arch.h b/src/include/lwip/arch.h index 7b99c260..261cf8b1 100644 --- a/src/include/lwip/arch.h +++ b/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. diff --git a/src/include/lwip/debug.h b/src/include/lwip/debug.h index 973a633d..cd6eacff 100644 --- a/src/include/lwip/debug.h +++ b/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. diff --git a/src/include/lwip/def.h b/src/include/lwip/def.h index 3bd0db84..39d720c0 100644 --- a/src/include/lwip/def.h +++ b/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. diff --git a/src/include/lwip/dhcp.h b/src/include/lwip/dhcp.h index 579bc98b..3e2c6d29 100644 --- a/src/include/lwip/dhcp.h +++ b/src/include/lwip/dhcp.h @@ -1,3 +1,8 @@ +/** + * @file + * DHCP client API + */ + /* * Copyright (c) 2001-2004 Leon Woestenberg * Copyright (c) 2001-2004 Axon Digital Design B.V., The Netherlands. diff --git a/src/include/lwip/dns.h b/src/include/lwip/dns.h index 22a73555..cf78ace3 100644 --- a/src/include/lwip/dns.h +++ b/src/include/lwip/dns.h @@ -1,3 +1,8 @@ +/** + * @file + * DNS API + */ + /** * lwip DNS resolver header file. diff --git a/src/include/lwip/err.h b/src/include/lwip/err.h index 548ba6aa..651d7878 100644 --- a/src/include/lwip/err.h +++ b/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. diff --git a/src/include/lwip/icmp.h b/src/include/lwip/icmp.h index af3a4550..090446ad 100644 --- a/src/include/lwip/icmp.h +++ b/src/include/lwip/icmp.h @@ -1,3 +1,8 @@ +/** + * @file + * ICMP API + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/igmp.h b/src/include/lwip/igmp.h index b0a6af75..292e5c3b 100644 --- a/src/include/lwip/igmp.h +++ b/src/include/lwip/igmp.h @@ -1,3 +1,8 @@ +/** + * @file + * IGMP API + */ + /* * Copyright (c) 2002 CITEL Technologies Ltd. * All rights reserved. diff --git a/src/include/lwip/inet_chksum.h b/src/include/lwip/inet_chksum.h index 1766f4b5..52d76d38 100644 --- a/src/include/lwip/inet_chksum.h +++ b/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. diff --git a/src/include/lwip/init.h b/src/include/lwip/init.h index 216de2c0..1b83923c 100644 --- a/src/include/lwip/init.h +++ b/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. diff --git a/src/include/lwip/ip.h b/src/include/lwip/ip.h index d42fe681..4e4b1f70 100644 --- a/src/include/lwip/ip.h +++ b/src/include/lwip/ip.h @@ -1,3 +1,8 @@ +/** + * @file + * IP API + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/ip4.h b/src/include/lwip/ip4.h index e69e55c7..c78c1194 100644 --- a/src/include/lwip/ip4.h +++ b/src/include/lwip/ip4.h @@ -1,3 +1,8 @@ +/** + * @file + * IPv4 API + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/ip4_addr.h b/src/include/lwip/ip4_addr.h index 14363a33..16f4f79a 100644 --- a/src/include/lwip/ip4_addr.h +++ b/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. diff --git a/src/include/lwip/ip_addr.h b/src/include/lwip/ip_addr.h index e7e09fd9..1cbeb54d 100644 --- a/src/include/lwip/ip_addr.h +++ b/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. diff --git a/src/include/lwip/ip_frag.h b/src/include/lwip/ip_frag.h index deeb2f4e..5a092f69 100644 --- a/src/include/lwip/ip_frag.h +++ b/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. diff --git a/src/include/lwip/mem.h b/src/include/lwip/mem.h index 76181a90..66537a9e 100644 --- a/src/include/lwip/mem.h +++ b/src/include/lwip/mem.h @@ -1,3 +1,8 @@ +/** + * @file + * Heap API + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/memp.h b/src/include/lwip/memp.h index d7463f2b..0b6fe043 100644 --- a/src/include/lwip/memp.h +++ b/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. diff --git a/src/include/lwip/netbuf.h b/src/include/lwip/netbuf.h index 8875e12d..1671488a 100644 --- a/src/include/lwip/netbuf.h +++ b/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. diff --git a/src/include/lwip/netdb.h b/src/include/lwip/netdb.h index 144a6e0b..8da12c28 100644 --- a/src/include/lwip/netdb.h +++ b/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: diff --git a/src/include/lwip/netif.h b/src/include/lwip/netif.h index 07e8eec0..6f615c94 100644 --- a/src/include/lwip/netif.h +++ b/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. diff --git a/src/include/lwip/netifapi.h b/src/include/lwip/netifapi.h index b40028f8..0071f921 100644 --- a/src/include/lwip/netifapi.h +++ b/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: diff --git a/src/include/lwip/pbuf.h b/src/include/lwip/pbuf.h index fa0857dc..fa31bc68 100644 --- a/src/include/lwip/pbuf.h +++ b/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; diff --git a/src/include/lwip/priv/api_msg.h b/src/include/lwip/priv/api_msg.h index d37bd15d..ad383456 100644 --- a/src/include/lwip/priv/api_msg.h +++ b/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. diff --git a/src/include/lwip/priv/memp_priv.h b/src/include/lwip/priv/memp_priv.h index 34edb9d9..d6f63b06 100644 --- a/src/include/lwip/priv/memp_priv.h +++ b/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. diff --git a/src/include/lwip/priv/memp_std.h b/src/include/lwip/priv/memp_std.h index 5d36bee3..44e15662 100644 --- a/src/include/lwip/priv/memp_std.h +++ b/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. * diff --git a/src/include/lwip/priv/tcp_priv.h b/src/include/lwip/priv/tcp_priv.h index b14e944e..d07664a1 100644 --- a/src/include/lwip/priv/tcp_priv.h +++ b/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. diff --git a/src/include/lwip/priv/tcpip_priv.h b/src/include/lwip/priv/tcpip_priv.h index 65b594fc..3d8f38e4 100644 --- a/src/include/lwip/priv/tcpip_priv.h +++ b/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. diff --git a/src/include/lwip/raw.h b/src/include/lwip/raw.h index 474fdc15..3d5e2cb9 100644 --- a/src/include/lwip/raw.h +++ b/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. diff --git a/src/include/lwip/snmp.h b/src/include/lwip/snmp.h index 07368cc6..8bfd2dba 100644 --- a/src/include/lwip/snmp.h +++ b/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 */ /* diff --git a/src/include/lwip/sockets.h b/src/include/lwip/sockets.h index 66a2725c..5a21011c 100644 --- a/src/include/lwip/sockets.h +++ b/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. diff --git a/src/include/lwip/stats.h b/src/include/lwip/stats.h index 176723d2..f483cc7e 100644 --- a/src/include/lwip/stats.h +++ b/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. diff --git a/src/include/lwip/sys.h b/src/include/lwip/sys.h index 86d0f3b3..2659726b 100644 --- a/src/include/lwip/sys.h +++ b/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. diff --git a/src/include/lwip/tcp.h b/src/include/lwip/tcp.h index 7166485a..060fea4f 100644 --- a/src/include/lwip/tcp.h +++ b/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. diff --git a/src/include/lwip/tcpip.h b/src/include/lwip/tcpip.h index adaadb99..15662e9a 100644 --- a/src/include/lwip/tcpip.h +++ b/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. diff --git a/src/include/lwip/timers.h b/src/include/lwip/timers.h index 1f9a396c..13259b19 100644 --- a/src/include/lwip/timers.h +++ b/src/include/lwip/timers.h @@ -1,3 +1,8 @@ +/** + * @file + * Timer implementations + */ + /* * Copyright (c) 2001-2004 Swedish Institute of Computer Science. * All rights reserved. diff --git a/src/include/lwip/udp.h b/src/include/lwip/udp.h index a370d3f9..1c9885ea 100644 --- a/src/include/lwip/udp.h +++ b/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. diff --git a/src/include/netif/etharp.h b/src/include/netif/etharp.h index 9d9be2f7..d23b6c23 100644 --- a/src/include/netif/etharp.h +++ b/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 diff --git a/src/include/netif/ethernet.h b/src/include/netif/ethernet.h index 17623e4a..03bfe7f8 100644 --- a/src/include/netif/ethernet.h +++ b/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 diff --git a/src/include/netif/lowpan6_opts.h b/src/include/netif/lowpan6_opts.h index 6a769575..fb93ea05 100644 --- a/src/include/netif/lowpan6_opts.h +++ b/src/include/netif/lowpan6_opts.h @@ -1,3 +1,8 @@ +/** + * @file + * 6LowPAN options list + */ + /* * Copyright (c) 2015 Inico Technologies Ltd. * All rights reserved. diff --git a/src/include/netif/slipif.h b/src/include/netif/slipif.h index d164d448..65ba31f8 100644 --- a/src/include/netif/slipif.h +++ b/src/include/netif/slipif.h @@ -1,3 +1,9 @@ +/** + * @file + * + * SLIP netif API + */ + /* * Copyright (c) 2001, Swedish Institute of Computer Science. * All rights reserved.