Document 6LoWPAN and SLIP netif

doc/doxygen/lwip.Doxyfile

@@ -781,7 +781,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src main_page.h ppp.h contrib.h
+INPUT                  = ../../src main_page.h contrib.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2106,6 +2106,8 @@ PREDEFINED             = NO_SYS=0 \
                          LWIP_SO_LINGER=1 \
                          SO_REUSE=1 \
                          SO_REUSE_RXTOALL=1 \
+                         LWIP_HAVE_SLIPIF=1 \
+                         LWIP_6LOWPAN=1 \
                          "LWIP_DNS && LWIP_SOCKET   " \
                          "(LWIP_DNS && LWIP_SOCKET)=1   "
 

doc/doxygen/ppp.h

@@ -1,5 +0,0 @@
-/**
- * @defgroup ppp PPP
- * @ingroup addons
- * @verbinclude "ppp.txt"
- */

src/netif/lowpan6.c

@@ -39,6 +39,12 @@
  * <delamer@inicotech.com>
  */
 
+/**
+ * @defgroup sixlowpan 6LowPAN netif
+ * @ingroup addons
+ * 6LowPAN netif implementation
+ */
+
 #include "netif/lowpan6.h"
 
 #if LWIP_IPV6 && LWIP_6LOWPAN

src/netif/ppp/ppp.c

@@ -79,6 +79,12 @@
  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  */
 
+/**
+ * @defgroup ppp PPP netif
+ * @ingroup addons
+ * @verbinclude "ppp.txt"
+ */
+
 #include "netif/ppp/ppp_opts.h"
 #if PPP_SUPPORT /* don't build if not configured for use in lwipopts.h */
 

src/netif/slipif.c

@@ -36,12 +36,21 @@
  *
  * Author: Magnus Ivarsson <magnus.ivarsson(at)volvo.com>
  *         Simon Goldschmidt
- *
- * Usage: This netif can be used in three ways:
+ */
+
+
+/**
+ * @defgroup slipif SLIP netif
+ * @ingroup addons
+ * 
+ * This is an arch independent SLIP netif. The specific serial hooks must be
+ * provided by another file. They are sio_open, sio_read/sio_tryread and sio_send
+ * 
+ * Usage: This netif can be used in three ways:\n
  *        1) For NO_SYS==0, an RX thread can be used which blocks on sio_read()
- *           until data is received.
+ *           until data is received.\n
  *        2) In your main loop, call slipif_poll() to check for new RX bytes,
- *           completed packets are fed into netif->input().
+ *           completed packets are fed into netif->input().\n
  *        3) Call slipif_received_byte[s]() from your serial RX ISR and
  *           slipif_process_rxqueue() from your main loop. ISR level decodes
  *           packets and puts completed packets on a queue which is fed into
@@ -50,11 +59,6 @@
  *
  */
 
-/*
- * This is an arch independent SLIP netif. The specific serial hooks must be
- * provided by another file. They are sio_open, sio_read/sio_tryread and sio_send
- */
-
 #include "netif/slipif.h"
 #include "lwip/opt.h"