Comments Fix for Doxygen documentation

src/api/api_lib.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Sequential API External module
+ *
+ */
+ 
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 
@@ -671,7 +677,7 @@ netconn_recv(struct netconn *conn)
  * @param conn the netconn over which to send data
  * @param buf a netbuf containing the data to send
  * @param addr the remote IP address to which to send the data
- * @param addr the remote port to which to send the data
+ * @param port the remote port to which to send the data
  * @return ERR_OK if data was sent, any other err_t on error
  */
 err_t

src/api/api_msg.c

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

src/api/err.c

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

src/api/netifapi.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Network Interface Sequential API module
+ *
+ */
+
 /*
  * Redistribution and use in source and binary forms, with or without modification, 
  * are permitted provided that the following conditions are met:

src/api/sockets.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Sockets BSD-Like API module
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/api/tcpip.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Sequential API Main thread module
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/core/dhcp.c

@@ -1,7 +1,7 @@
 /**
  * @file
- *
  * Dynamic Host Configuration Protocol client
+ *
  */
 
 /*
@@ -90,7 +90,7 @@
  *  with this value (easy to match with a packet analyzer) */
 static u32_t xid = 0xABCD0000;
 
-/** DHCP client state machine functions */
+/* DHCP client state machine functions */
 static void dhcp_handle_ack(struct netif *netif);
 static void dhcp_handle_nak(struct netif *netif);
 static void dhcp_handle_offer(struct netif *netif);
@@ -103,7 +103,7 @@ static err_t dhcp_decline(struct netif *netif);
 static err_t dhcp_rebind(struct netif *netif);
 static void dhcp_set_state(struct dhcp *dhcp, u8_t new_state);
 
-/** receive, unfold, parse and free incoming messages */
+/* receive, unfold, parse and free incoming messages */
 static void dhcp_recv(void *arg, struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *addr, u16_t port);
 static err_t dhcp_unfold_reply(struct dhcp *dhcp);
 static u8_t *dhcp_get_option_ptr(struct dhcp *dhcp, u8_t option_type);
@@ -114,23 +114,23 @@ static u16_t dhcp_get_option_short(u8_t *ptr);
 static u32_t dhcp_get_option_long(u8_t *ptr);
 static void dhcp_free_reply(struct dhcp *dhcp);
 
-/** set the DHCP timers */
+/* set the DHCP timers */
 static void dhcp_timeout(struct netif *netif);
 static void dhcp_t1_timeout(struct netif *netif);
 static void dhcp_t2_timeout(struct netif *netif);
 
-/** build outgoing messages */
+/* build outgoing messages */
-/** create a DHCP request, fill in common headers */
+/* create a DHCP request, fill in common headers */
 static err_t dhcp_create_request(struct netif *netif);
-/** free a DHCP request */
+/* free a DHCP request */
 static void dhcp_delete_request(struct netif *netif);
-/** add a DHCP option (type, then length in bytes) */
+/* add a DHCP option (type, then length in bytes) */
 static void dhcp_option(struct dhcp *dhcp, u8_t option_type, u8_t option_len);
-/** add option values */
+/* add option values */
 static void dhcp_option_byte(struct dhcp *dhcp, u8_t value);
 static void dhcp_option_short(struct dhcp *dhcp, u16_t value);
 static void dhcp_option_long(struct dhcp *dhcp, u32_t value);
-/** always add the DHCP options trailer to end and pad */
+/* always add the DHCP options trailer to end and pad */
 static void dhcp_option_trailer(struct dhcp *dhcp);
 
 /**

src/core/inet.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ * Functions common to all TCP/IPv4 modules, such as the Internet checksum and the
+ * byte order functions.
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.
@@ -30,15 +37,6 @@
  *
  */
 
-
-/* inet.c
- *
- * Functions common to all TCP/IP modules, such as the Internet checksum and the
- * byte order functions.
- *
- */
-
-
 #include "lwip/opt.h"
 
 #include "lwip/arch.h"
@@ -489,7 +487,7 @@ inet_aton(const char *cp, struct in_addr *addr)
  * Convert numeric IP address into decimal dotted ASCII representation.
  * returns ptr to static buffer; not reentrant!
  *
- * @paran addr ip address in network order to convert
+ * @param addr ip address in network order to convert
  * @return pointer to a global static (!) buffer that holds the ASCII
  *         represenation of addr
  */

src/core/inet6.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ * Functions common to all TCP/IPv6 modules, such as the Internet checksum and the
+ * byte order functions.
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 
@@ -30,22 +37,11 @@
  *
  */
 
-
-/* inet6.c
- *
- * Functions common to all TCP/IP modules, such as the Internet checksum and the
- * byte order functions.
- *
- */
-
-
 #include "lwip/opt.h"
 
 #include "lwip/def.h"
 #include "lwip/inet.h"
 
-
-
 /* chksum:
  *
  * Sums up all 16 bit words in a memory portion. Also includes any odd byte.

src/core/ipv4/autoip.c

@@ -1,7 +1,7 @@
 /**
  * @file
- *
  * AutoIP Automatic LinkLocal IP Configuration
+ *
  */
 
 /*

src/core/ipv4/icmp.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * ICMP - Internet Control Message Protocol
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/core/ipv4/igmp.c

@@ -1,7 +1,7 @@
 /**
  * @file
- *
  * IGMP - Internet Group Management Protocol
+ *
  */
 
 /*
@@ -577,7 +577,7 @@ igmp_ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
 /**
  * Send an igmp packet to a specific group.
  *
- * @param the group to which to send the packet
+ * @param group the group to which to send the packet
  * @param type the type of igmp packet to send
  */
 void

src/core/ipv4/ip.c

@@ -1,10 +1,11 @@
-/* @file
+/**
- *
+ * @file
- * This is the IP layer implementation for incoming and outgoing IP traffic.
+ * This is the IPv4 layer implementation for incoming and outgoing IP traffic.
  * 
  * @see ip_frag.c
  *
  */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.

src/core/ipv4/ip_addr.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * This is the IPv4 address tools implementation.
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 

src/core/ipv4/ip_frag.c

@@ -1,6 +1,6 @@
-/* @file
+/**
- * 
+ * @file
- * This is the IP packet segmentation and reassembly implementation.
+ * This is the IPv4 packet segmentation and reassembly implementation.
  *
  */
 

src/core/mem.c

@@ -1,5 +1,5 @@
-/** @file
+/**
- *
+ * @file
  * Dynamic memory manager
  *
  */

src/core/memp.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Dynamic pool memory manager
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 
@@ -317,6 +323,8 @@ memp_init(void)
  * Get an element from a specific pool.
  *
  * @param type the pool to get an element from
+ * @param file file name calling this function
+ * @param line number of line where this function is called
  */
 void *
 #if MEMP_OVERFLOW_CHECK

src/core/netif.c

@@ -1,7 +1,7 @@
 /**
  * @file
- *
  * lwIP network interface abstraction
+ *
  */
 
 /*

src/core/raw.c

@@ -1,11 +1,11 @@
 /**
  * @file
- * 
  * Implementation of raw protocol PCBs for low-level handling of
  * different types of protocols besides (or overriding) those
  * already available in lwIP.
  *
  */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.
@@ -76,9 +76,9 @@ raw_init(void)
  * finds a corresponding RAW PCB and calls the corresponding receive
  * callback function.
  *
- * @param pbuf pbuf to be demultiplexed to a RAW PCB.
+ * @param p pbuf to be demultiplexed to a RAW PCB.
- * @param netif network interface on which the datagram was received.
+ * @param inp network interface on which the datagram was received.
- * @Return - 1 if the packet has been eaten by a RAW PCB receive
+ * @return - 1 if the packet has been eaten by a RAW PCB receive
  *           callback function. The caller MAY NOT not reference the
  *           packet any longer, and MAY NOT call pbuf_free().
  * @return - 0 if packet is not eaten (pbuf is still referenced by the
@@ -269,7 +269,6 @@ raw_sendto(struct raw_pcb *pcb, struct pbuf *p, struct ip_addr *ipaddr)
  *
  * @param pcb the raw pcb which to send
  * @param p the IP payload to send
- * @param ipaddr the destination address of the IP packet
  *
  */
 err_t

src/core/snmp/mib2.c

@@ -914,7 +914,7 @@ void objectidncpy(s32_t *dst, s32_t *src, u8_t n)
  * Initializes sysDescr pointers.
  *
  * @param str if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param len points to string length, excluding zero terminator
  */
 void snmp_set_sysdesr(u8_t *str, u8_t *len)
 {
@@ -958,8 +958,8 @@ void snmp_get_sysuptime(u32_t *value)
  * Initializes sysContact pointers,
  * e.g. ptrs to non-volatile memory external to lwIP.
  *
- * @param str if non-NULL then copy str pointer
+ * @param ocstr if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstrlen points to string length, excluding zero terminator
  */
 void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen)
 {
@@ -974,8 +974,8 @@ void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen)
  * Initializes sysName pointers,
  * e.g. ptrs to non-volatile memory external to lwIP.
  *
- * @param str if non-NULL then copy str pointer
+ * @param ocstr if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstrlen points to string length, excluding zero terminator
  */
 void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen)
 {
@@ -990,8 +990,8 @@ void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen)
  * Initializes sysLocation pointers,
  * e.g. ptrs to non-volatile memory external to lwIP.
  *
- * @param str if non-NULL then copy str pointer
+ * @param ocstr if non-NULL then copy str pointer
- * @param strlen points to string length, excluding zero terminator
+ * @param ocstrlen points to string length, excluding zero terminator
  */
 void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen)
 {
@@ -1416,7 +1416,7 @@ void snmp_delete_ipaddridx_tree(struct netif *ni)
  * into index tree.
  *
  * @param dflt non-zero for the default rte, zero for network rte
- * @param netif points to network interface for this rte
+ * @param ni points to network interface for this rte
  *
  * @todo record sysuptime for _this_ route when it is installed
  *   (needed for ipRouteAge) in the netif.
@@ -1493,7 +1493,7 @@ void snmp_insert_iprteidx_tree(u8_t dflt, struct netif *ni)
  * from index tree.
  *
  * @param dflt non-zero for the default rte, zero for network rte
- * @param netif points to network interface for this rte or NULL
+ * @param ni points to network interface for this rte or NULL
  *   for default route to be removed.
  */
 void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni)

src/core/snmp/mib_structs.c

@@ -110,7 +110,7 @@ snmp_ifindextonetif(s32_t ifindex, struct netif **netif)
 /**
  * Conversion from lwIP netif to ifIndex
  * @param netif points to a netif struct
- * @param ifindex points to s32_t object sub-identifier
+ * @param ifidx points to s32_t object sub-identifier
  */
 void
 snmp_netiftoifindex(struct netif *netif, s32_t *ifidx)

src/core/stats.c

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

src/core/sys.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * lwIP Operating System abstraction
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.
@@ -289,6 +295,7 @@ sswt_handler(void *arg)
 /**
  * Wait for a semaphore with timeout (specified in ms)
  *
+ * @param sem semaphore to wait
  * @param timeout timeout in ms (0: wait forever)
  * @return 0 on timeout, 1 otherwise
  */

src/core/tcp.c

@@ -1,6 +1,5 @@
 /**
  * @file
- *
  * Transmission Control Protocol for IP
  *
  * This file contains common functions for the TCP implementation, such as functinos
@@ -1122,6 +1121,7 @@ tcp_pcb_purge(struct tcp_pcb *pcb)
 /**
  * Purges the PCB and removes it from a PCB list. Any delayed ACKs are sent first.
  *
+ * @param pcblist PCB list to purge.
  * @param pcb tcp_pcb to purge. The pcb itself is also deallocated!
  */
 void

src/core/tcp_in.c

@@ -1,6 +1,5 @@
 /**
  * @file
- *
  * Transmission Control Protocol, incoming traffic
  *
  * The input processing functions of the TCP layer.

src/core/tcp_out.c

@@ -1,6 +1,5 @@
 /**
  * @file
- *
  * Transmission Control Protocol, outgoing traffic
  *
  * The output functions of TCP.

src/core/udp.c

@@ -3,6 +3,7 @@
  * User Datagram Protocol module
  *
  */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved.
@@ -684,7 +685,7 @@ udp_disconnect(struct udp_pcb *pcb)
  *
  * @param pcb the pcb for wich to set the recv callback
  * @param recv function pointer of the callback function
- * @param arg additional argument to pass to the callback function
+ * @param recv_arg additional argument to pass to the callback function
  */
 void
 udp_recv(struct udp_pcb *pcb,

src/netif/ethernetif.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * Ethernet Interface Skeleton
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 

src/netif/loopif.c

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

src/netif/slipif.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * SLIP Interface
+ *
+ */
+
 /*
  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  * All rights reserved. 
@@ -227,7 +233,7 @@ slipif_loop(void *nf)
  * Call the arch specific sio_open and remember
  * the opened device in the state field of the netif.
  *
- * @param nf the lwip network interface structure for this slipif
+ * @param netif the lwip network interface structure for this slipif
  * @return ERR_OK if serial line could be opened,
  *         ERR_IF is serial line couldn't be opened
  *