From 9940b049ec39b56bbb370fb9aa9992989a0490e0 Mon Sep 17 00:00:00 2001
From: fbernon <fbernon>
Date: Sun, 25 Nov 2007 00:28:06 +0000
Subject: [PATCH] Minor changes (documentation).

---
 README             | 29 +++++++++++++++++------------
 src/core/ipv4/ip.c | 10 +++++++++-
 2 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/README b/README
index 75c9b42f..8dda4b46 100644
--- a/README
+++ b/README
@@ -12,16 +12,21 @@ around 40 kilobytes of code ROM.
 
 FEATURES
 
- * IP (Internet Protocol) including packet forwarding over multiple
-   network interfaces
- * ICMP (Internet Control Message Protocol) for network maintenance
-   and debugging
- * UDP (User Datagram Protocol) including experimental UDP-lite
-   extensions
- * TCP (Transmission Control Protocol) with congestion control, RTT
-   estimation and fast recovery/fast retransmit
- * Specialized API for enhanced performance
- * Optional Berkeley socket API
+  * IP (Internet Protocol) including packet forwarding over multiple network
+    interfaces
+  * ICMP (Internet Control Message Protocol) for network maintenance and debugging
+  * IGMP (Internet Group Management Protocol) for multicast traffic management
+  * UDP (User Datagram Protocol) including experimental UDP-lite extensions
+  * TCP (Transmission Control Protocol) with congestion control, RTT estimation
+    and fast recovery/fast retransmit
+  * Specialized raw/native API for enhanced performance
+  * Optional Berkeley-like socket API
+  * DNS (Domain names resolver)
+  * SNMP (Simple Network Management Protocol)
+  * DHCP (Dynamic Host Configuration Protocol)
+  * AUTOIP (for IPv4, conform with RFC 3927)
+  * PPP (Point-to-Point Protocol)
+  * ARP (Address Resolution Protocol) for Ethernet
 
 LICENSE
 
@@ -65,7 +70,6 @@ lwIP are at the official lwIP home page:
 Self documentation of the source code is regularly extracted from the
 current CVS sources and is available from this web page:
   http://www.nongnu.org/lwip/
-[Unfortunately, this page is currently outdated!]
 
 There is now a constantly growin wiki about lwIP at
   http://lwip.scribblewiki.com/
@@ -81,4 +85,5 @@ documentation and browsing the mailing list archives is a good way to
 become familiar with the design of lwIP.
 
 Adam Dunkels <adam@sics.se>
-Leon Woestenberg <leon.woestenberg@gmx.net>		    
+Leon Woestenberg <leon.woestenberg@gmx.net>
+
diff --git a/src/core/ipv4/ip.c b/src/core/ipv4/ip.c
index 10534f1e..1b990ec8 100644
--- a/src/core/ipv4/ip.c
+++ b/src/core/ipv4/ip.c
@@ -498,7 +498,15 @@ ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
  * Simple interface to ip_output_if. It finds the outgoing network
  * interface and calls upon ip_output_if to do the actual work.
  *
- * See ip_ouptut_if for parameter declaration.
+ * @param p the packet to send (p->payload points to the data, e.g. next
+            protocol header; if dest == IP_HDRINCL, p already includes an IP
+            header and p->payload points to that IP header)
+ * @param src the source IP address to send from (if src == IP_ADDR_ANY, the
+ *         IP  address of the netif used to send is used as source address)
+ * @param dest the destination IP address to send the packet to
+ * @param ttl the TTL value to be set in the IP header
+ * @param tos the TOS value to be set in the IP header
+ * @param proto the PROTOCOL to be set in the IP header
  *
  * @return ERR_RTE if no route is found
  *         see ip_output_if() for more return values