deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Doxygen fixes

Browse source
This commit is contained in:
Simon Duquennoy 2014-12-02 12:00:00 +01:00
parent c2ca3e9fdb
commit 415506c3f6
5 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
apps/servreg-hack/servreg-hack.c
View file

@ -379,3 +379,5 @@ PROCESS_THREAD(servreg_hack_process, ev, data)
PROCESS_END(); PROCESS_END();
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @} */

2
core/net/ip/simple-udp.h
View file

@ -44,7 +44,7 @@
/** /**
* \defgroup simple-udp * \defgroup simple-udp A simple UDP API
* *
* The default Contiki UDP API is difficult to use. The simple-udp * The default Contiki UDP API is difficult to use. The simple-udp
* module provides a significantly simpler API. * module provides a significantly simpler API.

2
core/net/ipv6/uip-icmp6.h
View file

@ -112,7 +112,7 @@ typedef struct uip_icmp6_error{
* \brief Send an icmpv6 error message * \brief Send an icmpv6 error message
* \param type type of the error message * \param type type of the error message
* \param code of the error message * \param code of the error message
* \param type 32 bit parameter of the error message, semantic depends on error * \param param 32 bit parameter of the error message, semantic depends on error
*/ */
void void
uip_icmp6_error_output(uint8_t type, uint8_t code, uint32_t param); uip_icmp6_error_output(uint8_t type, uint8_t code, uint32_t param);

2
doc/Makefile
View file

@ -33,7 +33,7 @@ init:
@echo "> Scanning files" @echo "> Scanning files"
# This target requires and graphviz and doxygen # This target requires and graphviz and doxygen
doxygen.log: docdirs = $(sort ,$(foreach dir,$(basedirs),${shell find ../${dir} -type d -not -path "*/.*" -not -path "*/obj_*"})) doxygen.log: docdirs = $(sort $(foreach dir,$(basedirs),${shell find ../${dir} -type d -not -path "*/.*" -not -path "*/obj_*"}))
doxygen.log: docsrc = $(docdirs) $(foreach dir,$(docdirs),${shell find $(dir) -type f $(filetypes)}) $(manuals) doxygen.log: docsrc = $(docdirs) $(foreach dir,$(docdirs),${shell find $(dir) -type f $(filetypes)}) $(manuals)
doxygen.log: doxygen.log:
@doxygen Doxyfile @doxygen Doxyfile

24
doc/uip6-doc.txt
View file

@ -36,9 +36,9 @@ are part of the uIP IPv6 stack. A complete description can be found in the
corresponding IETF standards which are available at corresponding IETF standards which are available at
http://www.ietf.org/rfc.html. http://www.ietf.org/rfc.html.
\note The #UIP_CONF_IPV6 compilation flag is used to enable IPv6 (and \note The #NETSTACK_CONF_WITH_IPV6 compilation flag is used to enable IPv6.
disable IPv4). It is also recommended to set #UIP_CONF_IPV6_CHECKS to It is also recommended to set #UIP_CONF_IPV6_CHECKS to 1
1 if one cannot guarantee that the incoming packets are correctly formed. if one cannot guarantee that the incoming packets are correctly formed.
\subsection ipv6 IPv6 (RFC 2460) \subsection ipv6 IPv6 (RFC 2460)
The IP packets are processed in the #uip_process function. The IP packets are processed in the #uip_process function.
@ -236,15 +236,15 @@ This section just lists all IPv6 related compile time flags. Each flag
function is documented in this page in the appropriate section. function is documented in this page in the appropriate section.
\code \code
/*Boolean flags*/ /*Boolean flags*/
UIP_CONF_IPV6 NETSTACK_CONF_WITH_IPV6
UIP_CONF_IPV6_CHECKS UIP_CONF_IPV6_CHECKS
UIP_CONF_IPV6_QUEUE_PKT UIP_CONF_IPV6_QUEUE_PKT
UIP_CONF_IPV6_REASSEMBLY UIP_CONF_IPV6_REASSEMBLY
/*Integer flags*/ /*Integer flags*/
UIP_NETIF_MAX_ADDRESSES UIP_CONF_NETIF_MAX_ADDRESSES
UIP_ND6_MAX_PREFIXES UIP_CONF_ND6_MAX_PREFIXES
UIP_ND6_MAX_NEIGHBORS UIP_CONF_ND6_MAX_DEFROUTERS
UIP_ND6_MAX_DEFROUTER NBR_TABLE_CONF_MAX_NEIGHBORS
\endcode \endcode
<HR> <HR>
@ -257,10 +257,10 @@ reass "fragment reassembly" is enabled an additional buffer of the
same size is used. same size is used.
The only difference with the IPv4 code is the per %neighbor buffering The only difference with the IPv4 code is the per %neighbor buffering
that is available when #UIP_CONF_QUEUE_PKT is set to 1. This that is available when #UIP_CONF_IPV6_QUEUE_PKT is set to 1. This
additional buffering is used to queue one packet per %neighbor while additional buffering is used to queue one packet per %neighbor while
performing address resolution for it. This is a very costly feature as performing address resolution for it. This is a very costly feature as
it increases the RAM usage by approximately #UIP_ND6_MAX_NEIGHBORS * it increases the RAM usage by approximately #NBR_TABLE_CONF_MAX_NEIGHBORS *
#UIP_LINK_MTU bytes. #UIP_LINK_MTU bytes.
<HR> <HR>
@ -340,7 +340,7 @@ We will soon support RFC4944 transmission of IPv6 packets over 802.15.4\n
<b>IP layer</b><br> <b>IP layer</b><br>
\li IPv6 RFC2460 (MUST): When the compile flags UIP_CONF_IPV6_CHECKS and UIP_CONF_REASSEMBLY are set, full support \li IPv6 RFC2460 (MUST): When the compile flags UIP_CONF_IPV6_CHECKS and UIP_CONF_REASSEMBLY are set, full support
\li Neighbor Discovery RFC4861 (MUST): When the UIP_CONF_CHECKS and UIP_CONF_QUEUE_PKT flag are set, full support except redirect function \li Neighbor Discovery RFC4861 (MUST): When the UIP_CONF_CHECKS and UIP_CONF_IPV6_QUEUE_PKT flag are set, full support except redirect function
\li Address Autoconfiguration RFC4862 (MUST): When the UIP_CONF_CHECKS flag is set, full support except sending MLD report (see MLD) \li Address Autoconfiguration RFC4862 (MUST): When the UIP_CONF_CHECKS flag is set, full support except sending MLD report (see MLD)
\li Path MTU Discovery RFC 1981 (SHOULD): no support \li Path MTU Discovery RFC 1981 (SHOULD): no support
\li Jumbograms RFC 2675 (MAY): no support \li Jumbograms RFC 2675 (MAY): no support
@ -377,7 +377,5 @@ We pass all the tests for phase 2 except:
<HR> <HR>
@{
*/ */
/** @} */ /** @} */
/** @} */