diff --git a/doc/doxygen/lwip.Doxyfile b/doc/doxygen/lwip.Doxyfile index 0af10249..18eca665 100644 --- a/doc/doxygen/lwip.Doxyfile +++ b/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 rawapi.h ppp.h contrib.h sys_arch.h +INPUT = ../../src main_page.h ppp.h contrib.h sys_arch.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 diff --git a/doc/doxygen/ppp.h b/doc/doxygen/ppp.h index f2624477..cbd50812 100644 --- a/doc/doxygen/ppp.h +++ b/doc/doxygen/ppp.h @@ -1,4 +1,4 @@ /** - * @page ppp PPP + * @defgroup ppp PPP * @verbinclude "ppp.txt" */ diff --git a/doc/doxygen/rawapi.h b/doc/doxygen/rawapi.h deleted file mode 100644 index f5203e5c..00000000 --- a/doc/doxygen/rawapi.h +++ /dev/null @@ -1,4 +0,0 @@ -/** - * @page rawapi RAW API - * @verbinclude "rawapi.txt" - */ diff --git a/src/core/raw.c b/src/core/raw.c index a8fd7bad..8747353f 100644 --- a/src/core/raw.c +++ b/src/core/raw.c @@ -3,7 +3,7 @@ * Implementation of raw protocol PCBs for low-level handling of * different types of protocols besides (or overriding) those * already available in lwIP.\n - * See also @ref rawapi + * See also @ref raw_raw */ /* @@ -40,7 +40,16 @@ /** * @defgroup raw_api RAW API - * @see @ref rawapi + * @verbinclude "rawapi.txt" + */ + +/** + * @defgroup raw_raw RAW + * @ingroup raw_api + * Implementation of raw protocol PCBs for low-level handling of + * different types of protocols besides (or overriding) those + * already available in lwIP.\n + * @see @ref raw_api */ #include "lwip/opt.h" @@ -190,6 +199,7 @@ raw_input(struct pbuf *p, struct netif *inp) } /** + * @ingroup raw_raw * Bind a RAW PCB. * * @param pcb RAW PCB to be bound with a local address ipaddr. @@ -214,6 +224,7 @@ raw_bind(struct raw_pcb *pcb, const ip_addr_t *ipaddr) } /** + * @ingroup raw_raw * Connect an RAW PCB. This function is required by upper layers * of lwip. Using the raw api you could use raw_sendto() instead * @@ -237,6 +248,7 @@ raw_connect(struct raw_pcb *pcb, const ip_addr_t *ipaddr) } /** + * @ingroup raw_raw * Set the callback function for received packets that match the * raw PCB's protocol and binding. * @@ -258,6 +270,7 @@ raw_recv(struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg) } /** + * @ingroup raw_raw * Send the raw IP packet to the given address. Note that actually you cannot * modify the IP headers (this is inconsistent with the receive callback where * you actually get the IP headers), you can only specify the IP payload here. @@ -383,6 +396,7 @@ raw_sendto(struct raw_pcb *pcb, struct pbuf *p, const ip_addr_t *ipaddr) } /** + * @ingroup raw_raw * Send the raw IP packet to the address given by raw_connect() * * @param pcb the raw pcb which to send @@ -396,6 +410,7 @@ raw_send(struct raw_pcb *pcb, struct pbuf *p) } /** + * @ingroup raw_raw * Remove an RAW PCB. * * @param pcb RAW PCB to be removed. The PCB is removed from the list of @@ -426,6 +441,7 @@ raw_remove(struct raw_pcb *pcb) } /** + * @ingroup raw_raw * Create a RAW PCB. * * @return The RAW PCB which was created. NULL if the PCB data structure @@ -456,7 +472,8 @@ raw_new(u8_t proto) } /** - * Create a RAW PCB for IPv6. + * @ingroup raw_raw + * Create a RAW PCB for specific IP type. * * @return The RAW PCB which was created. NULL if the PCB data structure * could not be allocated. diff --git a/src/core/tcp.c b/src/core/tcp.c index 52e94cec..0e46b27d 100644 --- a/src/core/tcp.c +++ b/src/core/tcp.c @@ -1,12 +1,7 @@ /** - * @file + * @file * Transmission Control Protocol for IP - * - * This file contains common functions for the TCP implementation, such as functinos - * for manipulating the data structures and the TCP timer functions. TCP functions - * related to input and output is found in tcp_in.c and tcp_out.c respectively.\n - * - * See also @ref rawapi + * See also @ref tcp_raw */ /* @@ -44,7 +39,12 @@ /** * @defgroup tcp_raw TCP * @ingroup raw_api - * @see @ref rawapi + * Transmission Control Protocol for IP\n + * @see @ref raw_api + * + * Common functions for the TCP implementation, such as functinos + * for manipulating the data structures and the TCP timer functions. TCP functions + * related to input and output is found in tcp_in.c and tcp_out.c respectively.\n */ #include "lwip/opt.h" diff --git a/src/core/udp.c b/src/core/udp.c index 844ffcb8..622c1a88 100644 --- a/src/core/udp.c +++ b/src/core/udp.c @@ -1,8 +1,7 @@ /** * @file * User Datagram Protocol module\n - * - * See also @ref rawapi + * See also @ref udp_raw */ /* @@ -40,7 +39,8 @@ /** * @defgroup udp_raw UDP * @ingroup raw_api - * @see @ref rawapi + * User Datagram Protocol module\n + * @see @ref raw_api */ /* udp.c diff --git a/src/include/lwip/raw.h b/src/include/lwip/raw.h index c70a6591..f92c8ee9 100644 --- a/src/include/lwip/raw.h +++ b/src/include/lwip/raw.h @@ -1,7 +1,7 @@ /** * @file * raw API (to be used from TCPIP thread)\n - * See also @ref rawapi + * See also @ref raw_raw */ /* diff --git a/src/include/lwip/tcp.h b/src/include/lwip/tcp.h index b18c6151..395692ac 100644 --- a/src/include/lwip/tcp.h +++ b/src/include/lwip/tcp.h @@ -1,7 +1,7 @@ /** * @file * TCP API (to be used from TCPIP thread)\n - * See also @ref rawapi + * See also @ref tcp_raw */ /* diff --git a/src/include/lwip/udp.h b/src/include/lwip/udp.h index d6156040..a0381ddd 100644 --- a/src/include/lwip/udp.h +++ b/src/include/lwip/udp.h @@ -1,7 +1,7 @@ /** * @file * UDP API (to be used from TCPIP thread)\n - * See also @ref rawapi + * See also @ref udp_raw */ /*