diff --git a/arch/cpu/arm/common/CMSIS/core_cm0.h b/arch/cpu/arm/common/CMSIS/core_cm0.h index 1ce683576..6d31eec8a 100644 --- a/arch/cpu/arm/common/CMSIS/core_cm0.h +++ b/arch/cpu/arm/common/CMSIS/core_cm0.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_cm0plus.h b/arch/cpu/arm/common/CMSIS/core_cm0plus.h index 8dc698a9a..ee5eec184 100644 --- a/arch/cpu/arm/common/CMSIS/core_cm0plus.h +++ b/arch/cpu/arm/common/CMSIS/core_cm0plus.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_cm3.h b/arch/cpu/arm/common/CMSIS/core_cm3.h index de1113688..9e66eca9e 100644 --- a/arch/cpu/arm/common/CMSIS/core_cm3.h +++ b/arch/cpu/arm/common/CMSIS/core_cm3.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_cm4.h b/arch/cpu/arm/common/CMSIS/core_cm4.h index 218bc0dfa..2594f821f 100644 --- a/arch/cpu/arm/common/CMSIS/core_cm4.h +++ b/arch/cpu/arm/common/CMSIS/core_cm4.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_cm7.h b/arch/cpu/arm/common/CMSIS/core_cm7.h index 1c1a5e68f..a1517671c 100644 --- a/arch/cpu/arm/common/CMSIS/core_cm7.h +++ b/arch/cpu/arm/common/CMSIS/core_cm7.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_sc000.h b/arch/cpu/arm/common/CMSIS/core_sc000.h index 514dbd81b..7604ba198 100644 --- a/arch/cpu/arm/common/CMSIS/core_sc000.h +++ b/arch/cpu/arm/common/CMSIS/core_sc000.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/arm/common/CMSIS/core_sc300.h b/arch/cpu/arm/common/CMSIS/core_sc300.h index 8bd18aa31..52886c653 100644 --- a/arch/cpu/arm/common/CMSIS/core_sc300.h +++ b/arch/cpu/arm/common/CMSIS/core_sc300.h @@ -48,7 +48,7 @@ #endif /** - \page CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions + CMSIS_MISRA_Exceptions MISRA-C:2004 Compliance Exceptions CMSIS violates the following MISRA-C:2004 rules: \li Required Rule 8.5, object/function definition in header file.
diff --git a/arch/cpu/cc26xx-cc13xx/clock.c b/arch/cpu/cc26xx-cc13xx/clock.c index 85ea6e444..98d18e653 100644 --- a/arch/cpu/cc26xx-cc13xx/clock.c +++ b/arch/cpu/cc26xx-cc13xx/clock.c @@ -32,7 +32,7 @@ * \addtogroup platform * @{ * - * \defgroup cc26xx-platforms TI CC26xx-powered Platforms + * \defgroup cc26xx-platforms TI CC26xx-powered platforms * @{ * * \defgroup cc26xx The TI CC26xx and CC13xx CPUs diff --git a/arch/cpu/nrf52832/ble/ble-core.c b/arch/cpu/nrf52832/ble/ble-core.c index cb3d4ce66..8466cf8ab 100644 --- a/arch/cpu/nrf52832/ble/ble-core.c +++ b/arch/cpu/nrf52832/ble/ble-core.c @@ -28,7 +28,7 @@ * */ /** - * \addtogroup cpu + * \addtogroup dev * @{ * * \addtogroup nrf52832 diff --git a/arch/cpu/nrf52832/ble/ble-core.h b/arch/cpu/nrf52832/ble/ble-core.h index 84c181d2e..12c678d42 100644 --- a/arch/cpu/nrf52832/ble/ble-core.h +++ b/arch/cpu/nrf52832/ble/ble-core.h @@ -28,7 +28,7 @@ * */ /** - * \addtogroup cpu + * \addtogroup dev * @{ * * \addtogroup nrf52832 diff --git a/arch/cpu/nrf52832/rtimer-arch.h b/arch/cpu/nrf52832/rtimer-arch.h index da709dae2..32c424829 100644 --- a/arch/cpu/nrf52832/rtimer-arch.h +++ b/arch/cpu/nrf52832/rtimer-arch.h @@ -28,7 +28,7 @@ * */ /** - * \addtogroup nrf52832 nRF52832 + * \addtogroup nrf52832 * @{ * * \file diff --git a/arch/platform/sky/doc/sky.txt b/arch/platform/sky/doc/sky.txt index e091a2770..7357ee921 100644 --- a/arch/platform/sky/doc/sky.txt +++ b/arch/platform/sky/doc/sky.txt @@ -3,12 +3,12 @@ **/ /** -\defgroup sky The Tmote Sky Board +\defgroup sky The Tmote Sky board The Tmote Sky platform is a wireless sensor board from Moteiv. It is an MSP430-based board with an 802.15.4-compatible CC2420 radio chip, a 1 megabyte external serial flash memory, and two light -sensors. Contiki was ported to the Tmote Sky by Björn Grönvall as part +sensors. Contiki was ported to the Tmote Sky by Björn Grönvall as part of the RUNES project. The Tmote Sky port was integrated into the Contiki build system in March 2007. diff --git a/arch/platform/zoul/contiki-conf.h b/arch/platform/zoul/contiki-conf.h index cb516031a..99a88ed52 100644 --- a/arch/platform/zoul/contiki-conf.h +++ b/arch/platform/zoul/contiki-conf.h @@ -29,10 +29,10 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup zoul + * \addtogroup platform * @{ * - * \defgroup zoul-platforms Zolertia platforms based on the Zoul core module + * \defgroup zoul-platforms Zolertia Zoul platforms * * The Zoul allows a fast reuse and easy integration to most applications and * products. Its small size and module format eases to place in different PCB diff --git a/arch/platform/zoul/dev/antenna-sw.h b/arch/platform/zoul/dev/antenna-sw.h index 6f02c8bb4..0e35f9578 100644 --- a/arch/platform/zoul/dev/antenna-sw.h +++ b/arch/platform/zoul/dev/antenna-sw.h @@ -28,7 +28,7 @@ */ /* -------------------------------------------------------------------------- */ /** - * \addtogroup remote + * \addtogroup zoul * @{ * * \defgroup remote-antenna RE-Mote Antenna switch diff --git a/arch/platform/zoul/dev/bme280-arch.c b/arch/platform/zoul/dev/bme280-arch.c index 86790e10f..0e21f9344 100644 --- a/arch/platform/zoul/dev/bme280-arch.c +++ b/arch/platform/zoul/dev/bme280-arch.c @@ -31,6 +31,8 @@ /*---------------------------------------------------------------------------*/ /** * \addtogroup zoul-bme280-sensor + * \ingroup zoul + * * @{ * * \file @@ -75,4 +77,3 @@ bme280_arch_i2c_read_mem(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t bytes) /** * @} */ - diff --git a/arch/platform/zoul/dev/mmc-arch.c b/arch/platform/zoul/dev/mmc-arch.c index 6fe6f6f0a..b2aff5a46 100644 --- a/arch/platform/zoul/dev/mmc-arch.c +++ b/arch/platform/zoul/dev/mmc-arch.c @@ -30,6 +30,7 @@ */ /** * \addtogroup mmc-arch + * \ingroup zoul * @{ * * \file diff --git a/arch/platform/zoul/dev/rtcc.h b/arch/platform/zoul/dev/rtcc.h index 898e9c264..92592e5ba 100644 --- a/arch/platform/zoul/dev/rtcc.h +++ b/arch/platform/zoul/dev/rtcc.h @@ -31,7 +31,7 @@ */ /* -------------------------------------------------------------------------- */ /** - * \addtogroup remote + * \addtogroup zoul * @{ * * \defgroup remote-rtcc RE-Mote Real Time Clock Calendar diff --git a/arch/platform/zoul/firefly-reva/board.h b/arch/platform/zoul/firefly-reva/board.h index db1eae2dc..fb72796c0 100644 --- a/arch/platform/zoul/firefly-reva/board.h +++ b/arch/platform/zoul/firefly-reva/board.h @@ -33,7 +33,7 @@ * \addtogroup zoul-platforms * @{ * - * \defgroup firefly-reva Firefly platform + * \addtogroup firefly * * The Zolertia Firefly is the most down-to-core development platform, exposing * the Zoul core functionalities and features, with a slick design to allow a @@ -272,7 +272,7 @@ */ #ifdef PLATFORM_CONF_WITH_BUTTON #if (PLATFORM_CONF_WITH_BUTTON && (ADC_SENSORS_ADC6_PIN == 3)) -#error "The ADC6 (PA3) and user button cannot be enabled at the same time" +#error "The ADC6 (PA3) and user button cannot be enabled at the same time" #else #define PLATFORM_HAS_BUTTON (PLATFORM_CONF_WITH_BUTTON && \ !(ADC_SENSORS_ADC6_PIN == 3)) diff --git a/arch/platform/zoul/fs/fat/ffconf.h b/arch/platform/zoul/fs/fat/ffconf.h index 526091835..cb4dca086 100644 --- a/arch/platform/zoul/fs/fat/ffconf.h +++ b/arch/platform/zoul/fs/fat/ffconf.h @@ -33,7 +33,7 @@ * POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup remote + * \addtogroup zoul * @{ * * \defgroup remote-fat RE-Mote FatFs diff --git a/arch/platform/zoul/remote-reva/power-mgmt.h b/arch/platform/zoul/remote-reva/power-mgmt.h index 6659fdb8c..33fbb7854 100644 --- a/arch/platform/zoul/remote-reva/power-mgmt.h +++ b/arch/platform/zoul/remote-reva/power-mgmt.h @@ -29,7 +29,7 @@ */ /*---------------------------------------------------------------------------*/ /** - * \addtogroup remote + * \addtogroup remote-reva * @{ * * \defgroup remote-power-mgmt-reva RE-Mote power management driver diff --git a/arch/platform/zoul/remote-revb/power-mgmt.h b/arch/platform/zoul/remote-revb/power-mgmt.h index de4ece3cd..d7ea54d79 100644 --- a/arch/platform/zoul/remote-revb/power-mgmt.h +++ b/arch/platform/zoul/remote-revb/power-mgmt.h @@ -29,7 +29,7 @@ */ /*---------------------------------------------------------------------------*/ /** - * \addtogroup remote + * \addtogroup remote-revb * @{ * * \defgroup remote-power-mgmt-revb RE-Mote power management driver diff --git a/doc/Doxyfile b/doc/Doxyfile index 9b885fe04..a923332ef 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "New Contiki" +PROJECT_NAME = "Contiki-NG" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -228,7 +228,7 @@ TAB_SIZE = 8 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = "os=New Contiki" +ALIASES = "os=Contiki-NG" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" @@ -564,7 +564,7 @@ SORT_MEMBERS_CTORS_1ST = NO # appear in their defined order. # The default value is: NO. -SORT_GROUP_NAMES = NO +SORT_GROUP_NAMES = YES # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will @@ -847,7 +847,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = pics +# IMAGE_PATH = pics # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program diff --git a/doc/apps.txt b/doc/apps.txt deleted file mode 100644 index f8b54e221..000000000 --- a/doc/apps.txt +++ /dev/null @@ -1,13 +0,0 @@ -/** - * \defgroup apps Applications - * - * \os provides a set of apps that provide functionalities such as a - * web server. - * - * To include an App in your software project specify in you makefile -@code -APPS = list of apps -@endcode - * - * @{ */ -/** @} */ diff --git a/doc/build-system.txt b/doc/build-system.txt index 89cb5c188..e950b1710 100644 --- a/doc/build-system.txt +++ b/doc/build-system.txt @@ -1,6 +1,7 @@ /** + \ingroup tutorials \defgroup buildsystem The \os build system - + The \os build system is designed to make it easy to compile \os applications for either to a hardware platform or into a simulation platform by simply supplying different parameters to the @@ -17,7 +18,7 @@ development system. After compiling the application for the native target it is possible to run the \os system with the application by running the file hello-world.native. - + To compile the hello-world application into a stand-alone executable that can be loaded into a running \os system, the command make hello-world.ce is used. To build an executable file for @@ -31,7 +32,7 @@ saved in the project's directory. \section buildsystem-makefiles Makefiles used in the \os build system - + The \os build system is composed of a number of Makefiles. These are: - Makefile: the project's makefile, located in the project directory. @@ -64,7 +65,7 @@ include $(CONTIKI)/Makefile.include First, the location of the \os source code tree is given by defining the CONTIKI variable. Next, the name of the application is defined. Finally, the system-wide - Makefile.include is included. + Makefile.include is included. The Makefile.include contains definitions of the C files of the core \os system. Makefile.include always reside in diff --git a/doc/code-style.txt b/doc/code-style.txt deleted file mode 100644 index 921104152..000000000 --- a/doc/code-style.txt +++ /dev/null @@ -1,3 +0,0 @@ -/** - \example code-style.c - */ diff --git a/doc/cpu.txt b/doc/cpu.txt deleted file mode 100644 index ecfca2c61..000000000 --- a/doc/cpu.txt +++ /dev/null @@ -1,50 +0,0 @@ -/** - * \defgroup cpu \os CPUs - * - */ - -/** - * \defgroup avr AVR - * \ingroup cpu - */ - -/** - * \defgroup wireless Wireless - * \ingroup avr - */ - -/** - * \defgroup arm ARM - * \ingroup cpu - */ - -/** - * \defgroup stm32w-cpu STM32W108 - * \ingroup cpu - */ - -/** - * \defgroup ccxxx CCxxx - * \ingroup cpu - */ - -/** - * \defgroup pic32 PIC32 \os Port - * \ingroup cpu - */ - -/** - * \defgroup ADUCRF101 ADUCRF101 - * \ingroup cpu - */ - -/** - * \defgroup native Native - * \ingroup cpu - */ - -/** - * \defgroup x86 x86 - * \ingroup cpu - */ - diff --git a/doc/dev.txt b/doc/dev.txt deleted file mode 100644 index a831d3392..000000000 --- a/doc/dev.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -\defgroup dev Device driver APIs -@{ -*/ -/** @} */ diff --git a/doc/lib.txt b/doc/lib.txt deleted file mode 100644 index d1250f902..000000000 --- a/doc/lib.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -\defgroup lib Libraries -@{ -*/ -/** @} */ diff --git a/doc/mainpage.txt b/doc/mainpage.txt index d2c833415..fba214d42 100644 --- a/doc/mainpage.txt +++ b/doc/mainpage.txt @@ -83,6 +83,6 @@ functionality, including memory management and data structures. \sa \ref heapmem "Heap memory allocator" \sa \ref list "Linked list library" \sa \ref ringbuf "Ring buffer library" -\sa \ref trickle-timer "Trickle timers" +\sa \ref trickle-timer "Trickle timer" */ diff --git a/doc/mem.txt b/doc/mem.txt deleted file mode 100644 index f96d8fa18..000000000 --- a/doc/mem.txt +++ /dev/null @@ -1,4 +0,0 @@ -/** -\defgroup mem Memory functions -\ingroup lib -*/ diff --git a/doc/modules.txt b/doc/modules.txt new file mode 100644 index 000000000..29ec64228 --- /dev/null +++ b/doc/modules.txt @@ -0,0 +1,123 @@ +/** +\defgroup arch Hardware support +CPU, device drivers and platform code +*/ + +/** + * \defgroup platform Platforms + * \ingroup arch + */ + +/** + * \addtogroup cc2538dk The cc2538 Development Kit platform + * \ingroup platform + */ + +/** + * \addtogroup cooja COOJA network simulator node + * \ingroup platform + */ + +/** + * \addtogroup exp5438 MSP430F5438 Experimenter Board + * \ingroup platform + */ + +/** + * \addtogroup jn516x The JN516x Board + * \ingroup platform + */ + +/** + * \addtogroup native_platform Native platform + * \ingroup platform + */ + +/** + * \addtogroup nrf52dk nRF52 Development Kit + * \ingroup platform + */ + +/** +\defgroup net IoT networking +*/ + +/** +\defgroup net-layer Network layer +Network-layer protocols and services +\ingroup net +*/ + +/** +\defgroup link-layer Link layer +link-layer protocols and services +\ingroup net +*/ + +/** +\defgroup uip uIP: the IPv6 stack +The low-power IPv6 stack +\ingroup net-layer +*/ + +/** +\defgroup rpl-lite RPL-lite +RPL-lite is a lightweight implementation of RPL tailored for reliability. +Supports only non-storing mode, one instance and one DAG. +\ingroup net-layer +*/ + +/** +\defgroup mem Memory functions +\ingroup lib +*/ + +/** +\defgroup data Data structures +\ingroup lib +*/ + +/** +\defgroup lib Libraries and services +*/ + +/** +\defgroup dev CPUs and Device driver +\ingroup arch +*/ + +/** +* \defgroup arm ARM CPUs +* \ingroup dev +*/ + +/** +* \addtogroup nrf52832 nrf52832 SoC +* \ingroup dev +*/ + +/** + * \defgroup apps Application-layer protocols and profiles + * \ingroup net +*/ + +/** + * \defgroup threads Threads and processes +This module contains protothreads, multithreading and processes + * \ingroup sys +*/ + +/** + * \defgroup timers Timers +This module contains all different timers and clocks in \os + * \ingroup sys +*/ + +/** + * \defgroup tutorials Tutorials +This module contains all \os related tutorials. +*/ + +/** + \example code-style.c + */ diff --git a/doc/net.txt b/doc/net.txt deleted file mode 100644 index 77b368cdd..000000000 --- a/doc/net.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -\defgroup net IoT networking -@{ -*/ -/** @} */ diff --git a/doc/pics/caution.gif b/doc/pics/caution.gif deleted file mode 100644 index c58de8e86..000000000 Binary files a/doc/pics/caution.gif and /dev/null differ diff --git a/doc/pics/contiki_menu_3290.jpg b/doc/pics/contiki_menu_3290.jpg deleted file mode 100644 index a5b2699f5..000000000 Binary files a/doc/pics/contiki_menu_3290.jpg and /dev/null differ diff --git a/doc/pics/dataframe.png b/doc/pics/dataframe.png deleted file mode 100644 index 94635e730..000000000 Binary files a/doc/pics/dataframe.png and /dev/null differ diff --git a/doc/pics/fcf.jpg b/doc/pics/fcf.jpg deleted file mode 100644 index 7e6ee985c..000000000 Binary files a/doc/pics/fcf.jpg and /dev/null differ diff --git a/doc/pics/layers.png b/doc/pics/layers.png deleted file mode 100644 index f603d7a9b..000000000 Binary files a/doc/pics/layers.png and /dev/null differ diff --git a/doc/pics/raven.jpg b/doc/pics/raven.jpg deleted file mode 100644 index 75408a295..000000000 Binary files a/doc/pics/raven.jpg and /dev/null differ diff --git a/doc/pics/raven.png b/doc/pics/raven.png deleted file mode 100644 index 8064f8f46..000000000 Binary files a/doc/pics/raven.png and /dev/null differ diff --git a/doc/pics/raven3290p.jpg b/doc/pics/raven3290p.jpg deleted file mode 100644 index 2a09dc0b1..000000000 Binary files a/doc/pics/raven3290p.jpg and /dev/null differ diff --git a/doc/pics/raven_detail.jpg b/doc/pics/raven_detail.jpg deleted file mode 100644 index 0639c8e2c..000000000 Binary files a/doc/pics/raven_detail.jpg and /dev/null differ diff --git a/doc/pics/ravenusb_large.jpg b/doc/pics/ravenusb_large.jpg deleted file mode 100644 index 687c5ca15..000000000 Binary files a/doc/pics/ravenusb_large.jpg and /dev/null differ diff --git a/doc/pics/ravenusb_medium.jpg b/doc/pics/ravenusb_medium.jpg deleted file mode 100644 index 879dd7bfb..000000000 Binary files a/doc/pics/ravenusb_medium.jpg and /dev/null differ diff --git a/doc/pics/ravenusb_network_connections.png b/doc/pics/ravenusb_network_connections.png deleted file mode 100644 index 9f35554b9..000000000 Binary files a/doc/pics/ravenusb_network_connections.png and /dev/null differ diff --git a/doc/pics/ravenusb_shortpins.jpg b/doc/pics/ravenusb_shortpins.jpg deleted file mode 100644 index 67cee1f3c..000000000 Binary files a/doc/pics/ravenusb_shortpins.jpg and /dev/null differ diff --git a/doc/pics/tutorial-raven-basic.jpg b/doc/pics/tutorial-raven-basic.jpg deleted file mode 100755 index f309dc720..000000000 Binary files a/doc/pics/tutorial-raven-basic.jpg and /dev/null differ diff --git a/doc/pics/tutorial-raven-connections.jpg b/doc/pics/tutorial-raven-connections.jpg deleted file mode 100755 index 94e298457..000000000 Binary files a/doc/pics/tutorial-raven-connections.jpg and /dev/null differ diff --git a/doc/pics/tutorial-raven-jtag.jpg b/doc/pics/tutorial-raven-jtag.jpg deleted file mode 100755 index 9d8cf6606..000000000 Binary files a/doc/pics/tutorial-raven-jtag.jpg and /dev/null differ diff --git a/doc/pics/wireshark_color.png b/doc/pics/wireshark_color.png deleted file mode 100644 index 52e0573a6..000000000 Binary files a/doc/pics/wireshark_color.png and /dev/null differ diff --git a/doc/pics/wireshark_explained.png b/doc/pics/wireshark_explained.png deleted file mode 100644 index 994baa77f..000000000 Binary files a/doc/pics/wireshark_explained.png and /dev/null differ diff --git a/doc/platform.txt b/doc/platform.txt deleted file mode 100644 index db50b1d06..000000000 --- a/doc/platform.txt +++ /dev/null @@ -1,33 +0,0 @@ -/** - * \defgroup platform \os platforms - */ - -/** - * \addtogroup cc2538dk The cc2538 Development Kit platform - * \ingroup platform - */ - -/** - * \addtogroup cooja COOJA network simulator node - * \ingroup platform - */ - -/** - * \addtogroup exp5438 MSP430F5438 Experimenter Board - * \ingroup platform - */ - -/** - * \addtogroup jn516x The JN516x Board - * \ingroup platform - */ - -/** - * \addtogroup native_platform Native platform - * \ingroup platform - */ - -/** - * \addtogroup nrf52dk nRF52 Development Kit - * \ingroup platform - */ diff --git a/doc/pt-doc.txt b/doc/pt-doc.txt index b0220f964..39984958c 100644 --- a/doc/pt-doc.txt +++ b/doc/pt-doc.txt @@ -1,10 +1,10 @@ /** -\addtogroup sys +\addtogroup threads @{ */ - + /** -\defgroup pt Protothreads +\defgroup pt Protothreads Protothreads are a type of lightweight stackless threads designed for severly memory constrained systems such as deeply embedded systems or @@ -46,22 +46,22 @@ Main features: - No machine specific code - the protothreads library is pure C - Does not use error-prone functions such as longjmp() - + - Very small RAM overhead - only two bytes per protothread - + - Can be used with or without an OS - + - Provides blocking wait without full multi-threading or stack-switching Examples applications: - Memory constrained systems - + - Event-driven protocol stacks - + - Deeply embedded systems - + - Sensor network nodes The protothreads API consists of four basic operations: @@ -71,7 +71,7 @@ convenience functions are built: reversed condition blocking: PT_WAIT_WHILE() and protothread blocking: PT_WAIT_THREAD(). \sa \ref pt "Protothreads API documentation" - + The protothreads library is released under a BSD-style license that allows for both non-commercial and commercial usage. The only requirement is that credit is given. @@ -123,7 +123,7 @@ generators provide multiple exit points from a generator function. \section pt-autovars Local variables -\note +\note Because protothreads do not save the stack context across a blocking call, local variables are not preserved when the protothread blocks. This means that local variables should be used with utmost @@ -151,7 +151,7 @@ Local continuations can be implemented in a variety of ways: -# by using machine specific assembler code, -# by using standard C constructs, or - -# by using compiler extensions. + -# by using compiler extensions. The first way works by saving and restoring the processor state, except for stack pointers, and requires between 16 and 32 bytes of @@ -169,10 +169,10 @@ protothreads. GCC supports label pointers that can be used for this purpose. With this implementation, protothreads require 4 bytes of RAM per protothread. -@{ +@{ */ /** @} */ -/** @} */ \ No newline at end of file +/** @} */ diff --git a/doc/sys.txt b/doc/sys.txt deleted file mode 100644 index 39ce067bf..000000000 --- a/doc/sys.txt +++ /dev/null @@ -1,5 +0,0 @@ -/** -\defgroup sys \os system -@{ -*/ -/** @} */ diff --git a/doc/tutorials.txt b/doc/tutorials.txt deleted file mode 100644 index dd4a44827..000000000 --- a/doc/tutorials.txt +++ /dev/null @@ -1,7 +0,0 @@ -/** - * \defgroup tutorials Tutorials - * @{ -This module contains all \os related tutorials. - -*/ -/** @} */ diff --git a/os/lib/crc16.h b/os/lib/crc16.h index e243f546e..f8ce5b7ae 100644 --- a/os/lib/crc16.h +++ b/os/lib/crc16.h @@ -42,7 +42,7 @@ * @{ */ /** - * \defgroup crc16 Cyclic Redundancy Check 16 (CRC16) calculation + * \defgroup crc16 CRC16 calculation * * The Cyclic Redundancy Check 16 is a hash function that produces a * checksum that is used to detect errors in transmissions. The CRC16 diff --git a/os/lib/heapmem.h b/os/lib/heapmem.h index 791319f2d..1f7b7a713 100644 --- a/os/lib/heapmem.h +++ b/os/lib/heapmem.h @@ -33,7 +33,7 @@ */ /** - * \defgroup heapmem Dynamic heap memory allocator + * \defgroup heapmem heapmem: Dynamic heap memory allocator * * The heapmem module is a dynamic heap memory allocator similar to * malloc() in standard C. The heap memory is managed in a block of diff --git a/os/lib/list.h b/os/lib/list.h index 0624682a2..7d3ff43d3 100644 --- a/os/lib/list.h +++ b/os/lib/list.h @@ -39,7 +39,7 @@ * */ -/** \addtogroup lib +/** \addtogroup data @{ */ /** * \defgroup list Linked list library @@ -79,7 +79,7 @@ * * The list variable is declared as static to make it easy to use in a * single C module without unnecessarily exporting the name to other - * modules. + * modules. * * \param name The name of the list. */ diff --git a/os/lib/memb.h b/os/lib/memb.h index d66e5a419..ffc555085 100644 --- a/os/lib/memb.h +++ b/os/lib/memb.h @@ -39,7 +39,7 @@ /** - * \defgroup memb Memory block management functions + * \defgroup memb memb: Memory block management functions * * The memory block allocation routines provide a simple yet powerful * set of functions for managing a set of memory blocks of fixed diff --git a/os/lib/ringbuf.h b/os/lib/ringbuf.h index 8ef12c457..d049ab2e9 100644 --- a/os/lib/ringbuf.h +++ b/os/lib/ringbuf.h @@ -37,7 +37,7 @@ * Adam Dunkels */ -/** \addtogroup lib +/** \addtogroup data * @{ */ /** diff --git a/os/net/ipv6/multicast/roll-tm.h b/os/net/ipv6/multicast/roll-tm.h index 59b9d1e92..8f69d6d01 100644 --- a/os/net/ipv6/multicast/roll-tm.h +++ b/os/net/ipv6/multicast/roll-tm.h @@ -30,7 +30,7 @@ */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/smrf.h b/os/net/ipv6/multicast/smrf.h index 2b2e44a5e..bbe7e5e26 100644 --- a/os/net/ipv6/multicast/smrf.h +++ b/os/net/ipv6/multicast/smrf.h @@ -30,7 +30,7 @@ */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6-engines.h b/os/net/ipv6/multicast/uip-mcast6-engines.h index 511029d2f..93e8da40f 100644 --- a/os/net/ipv6/multicast/uip-mcast6-engines.h +++ b/os/net/ipv6/multicast/uip-mcast6-engines.h @@ -30,7 +30,7 @@ */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6-route.c b/os/net/ipv6/multicast/uip-mcast6-route.c index c1ca80479..3c2d6bd3d 100644 --- a/os/net/ipv6/multicast/uip-mcast6-route.c +++ b/os/net/ipv6/multicast/uip-mcast6-route.c @@ -29,7 +29,7 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6-route.h b/os/net/ipv6/multicast/uip-mcast6-route.h index 39facb8a8..25bb435c7 100644 --- a/os/net/ipv6/multicast/uip-mcast6-route.h +++ b/os/net/ipv6/multicast/uip-mcast6-route.h @@ -29,7 +29,7 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6-stats.c b/os/net/ipv6/multicast/uip-mcast6-stats.c index d617358ba..7d7bed6e8 100644 --- a/os/net/ipv6/multicast/uip-mcast6-stats.c +++ b/os/net/ipv6/multicast/uip-mcast6-stats.c @@ -28,7 +28,7 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6-stats.h b/os/net/ipv6/multicast/uip-mcast6-stats.h index afb03ffda..474a432db 100644 --- a/os/net/ipv6/multicast/uip-mcast6-stats.h +++ b/os/net/ipv6/multicast/uip-mcast6-stats.h @@ -28,7 +28,7 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup uip6-multicast + * \addtogroup uip-multicast * @{ */ /** diff --git a/os/net/ipv6/multicast/uip-mcast6.h b/os/net/ipv6/multicast/uip-mcast6.h index 390948caa..67277828b 100644 --- a/os/net/ipv6/multicast/uip-mcast6.h +++ b/os/net/ipv6/multicast/uip-mcast6.h @@ -30,11 +30,11 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ /** - * \defgroup uip6-multicast IPv6 Multicast Forwarding + * \defgroup uip-multicast IPv6 Multicast Forwarding * * We currently support 2 engines: * - 'Stateless Multicast RPL Forwarding' (SMRF) diff --git a/os/net/ipv6/sicslowpan.c b/os/net/ipv6/sicslowpan.c index 4e7cca8c4..e1dd513e6 100644 --- a/os/net/ipv6/sicslowpan.c +++ b/os/net/ipv6/sicslowpan.c @@ -45,6 +45,7 @@ /** * \addtogroup sicslowpan + * \ingroup uip * @{ */ diff --git a/os/net/ipv6/uip-ds6-nbr.c b/os/net/ipv6/uip-ds6-nbr.c index 790adbeba..d07f85d78 100644 --- a/os/net/ipv6/uip-ds6-nbr.c +++ b/os/net/ipv6/uip-ds6-nbr.c @@ -30,7 +30,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-ds6-nbr.h b/os/net/ipv6/uip-ds6-nbr.h index 8f63c2634..ebb7de2d8 100644 --- a/os/net/ipv6/uip-ds6-nbr.h +++ b/os/net/ipv6/uip-ds6-nbr.h @@ -30,7 +30,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-ds6-route.c b/os/net/ipv6/uip-ds6-route.c index bf2522abf..e8327583a 100644 --- a/os/net/ipv6/uip-ds6-route.c +++ b/os/net/ipv6/uip-ds6-route.c @@ -30,7 +30,7 @@ * */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-ds6-route.h b/os/net/ipv6/uip-ds6-route.h index d554c4bcf..acc417670 100644 --- a/os/net/ipv6/uip-ds6-route.h +++ b/os/net/ipv6/uip-ds6-route.h @@ -30,7 +30,7 @@ * */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ /** diff --git a/os/net/ipv6/uip-ds6.c b/os/net/ipv6/uip-ds6.c index 0ae1c496e..20d44c9c5 100644 --- a/os/net/ipv6/uip-ds6.c +++ b/os/net/ipv6/uip-ds6.c @@ -29,7 +29,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-ds6.h b/os/net/ipv6/uip-ds6.h index ccb8aa634..736f9bfeb 100644 --- a/os/net/ipv6/uip-ds6.h +++ b/os/net/ipv6/uip-ds6.h @@ -1,5 +1,5 @@ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-icmp6.c b/os/net/ipv6/uip-icmp6.c index 8941166a9..0a48a134e 100644 --- a/os/net/ipv6/uip-icmp6.c +++ b/os/net/ipv6/uip-icmp6.c @@ -31,7 +31,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-icmp6.h b/os/net/ipv6/uip-icmp6.h index e64b4feb4..2808ea7de 100644 --- a/os/net/ipv6/uip-icmp6.h +++ b/os/net/ipv6/uip-icmp6.h @@ -31,7 +31,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-nameserver.c b/os/net/ipv6/uip-nameserver.c index 6e34346b0..83a1943b0 100644 --- a/os/net/ipv6/uip-nameserver.c +++ b/os/net/ipv6/uip-nameserver.c @@ -1,5 +1,5 @@ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-nameserver.h b/os/net/ipv6/uip-nameserver.h index 12473b35b..ed48f2246 100644 --- a/os/net/ipv6/uip-nameserver.h +++ b/os/net/ipv6/uip-nameserver.h @@ -1,5 +1,5 @@ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-nd6.c b/os/net/ipv6/uip-nd6.c index 0c61b34c7..5c01de392 100644 --- a/os/net/ipv6/uip-nd6.c +++ b/os/net/ipv6/uip-nd6.c @@ -57,7 +57,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip-nd6.h b/os/net/ipv6/uip-nd6.h index 01bfbc2fc..43b989490 100644 --- a/os/net/ipv6/uip-nd6.h +++ b/os/net/ipv6/uip-nd6.h @@ -31,7 +31,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/ipv6/uip6.c b/os/net/ipv6/uip6.c index e7604e290..b39f72ffe 100644 --- a/os/net/ipv6/uip6.c +++ b/os/net/ipv6/uip6.c @@ -32,7 +32,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/linkaddr.h b/os/net/linkaddr.h index 10c3ca762..6f7380218 100644 --- a/os/net/linkaddr.h +++ b/os/net/linkaddr.h @@ -38,12 +38,12 @@ */ /** - * \addtogroup netstack + * \addtogroup link-layer * @{ */ /** - * \defgroup linkaddr link-layer addresses + * \defgroup linkaddr Link-layer addresses * @{ * * The linkaddr module handles link-layer addresses. diff --git a/os/net/mac/framer/frame802154.h b/os/net/mac/framer/frame802154.h index e869f0c79..24a8c632c 100644 --- a/os/net/mac/framer/frame802154.h +++ b/os/net/mac/framer/frame802154.h @@ -44,7 +44,7 @@ */ /** - * \addtogroup net + * \addtogroup link-layer * @{ */ diff --git a/os/net/mac/llsec802154.h b/os/net/mac/llsec802154.h index 5f40e9988..195ab6381 100644 --- a/os/net/mac/llsec802154.h +++ b/os/net/mac/llsec802154.h @@ -30,6 +30,15 @@ * */ + /** + * \addtogroup link-layer + * \defgroup llsec802154 Link-Layer security common functionality + * + * Macros related to 802.15.4 link-layer security. + * + * @{ + */ + /** * \file * Common functionality of 802.15.4-compliant llsec_drivers. @@ -37,19 +46,6 @@ * Konrad Krentz */ -/** - * \addtogroup llsec - * @{ - */ - -/** - * \defgroup llsec802154 Link Layer Security Common Functionality - * - * Macros related to 802.15.4 link-layer security. - * - * @{ - */ - #ifndef LLSEC802154_H_ #define LLSEC802154_H_ @@ -87,4 +83,3 @@ #endif /* LLSEC802154_H_ */ /** @} */ -/** @} */ diff --git a/os/net/mac/tsch/sixtop/sixtop.h b/os/net/mac/tsch/sixtop/sixtop.h index 5ff0e6089..05377907b 100644 --- a/os/net/mac/tsch/sixtop/sixtop.h +++ b/os/net/mac/tsch/sixtop/sixtop.h @@ -28,7 +28,7 @@ * OF THE POSSIBILITY OF SUCH DAMAGE. */ /** - * \addtogroup net + * \addtogroup link-layer * @{ */ /** diff --git a/os/net/mac/tsch/tsch-adaptive-timesync.c b/os/net/mac/tsch/tsch-adaptive-timesync.c index 5d9774537..186d8d7ba 100644 --- a/os/net/mac/tsch/tsch-adaptive-timesync.c +++ b/os/net/mac/tsch/tsch-adaptive-timesync.c @@ -38,6 +38,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #include "net/mac/tsch/tsch.h" #include "net/mac/tsch/tsch-conf.h" #include "net/mac/tsch/tsch-adaptive-timesync.h" @@ -200,3 +205,4 @@ tsch_timesync_adaptive_compensate(rtimer_clock_t delta_ticks) } /*---------------------------------------------------------------------------*/ #endif /* TSCH_ADAPTIVE_TIMESYNC */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-adaptive-timesync.h b/os/net/mac/tsch/tsch-adaptive-timesync.h index f928856a7..e8398fdc2 100644 --- a/os/net/mac/tsch/tsch-adaptive-timesync.h +++ b/os/net/mac/tsch/tsch-adaptive-timesync.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_ADAPTIVE_TIMESYNC_H__ #define __TSCH_ADAPTIVE_TIMESYNC_H__ @@ -89,3 +94,4 @@ int32_t tsch_timesync_adaptive_compensate(rtimer_clock_t delta_ticks); long int tsch_adaptive_timesync_get_drift_ppm(void); #endif /* __TSCH_ADAPTIVE_TIMESYNC_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-asn.h b/os/net/mac/tsch/tsch-asn.h index 14802b8d7..9895cdcf4 100644 --- a/os/net/mac/tsch/tsch-asn.h +++ b/os/net/mac/tsch/tsch-asn.h @@ -38,6 +38,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_ASN_H__ #define __TSCH_ASN_H__ @@ -95,3 +100,4 @@ struct tsch_asn_divisor_t { % (div).val #endif /* __TSCH_ASN_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-conf.h b/os/net/mac/tsch/tsch-conf.h index 9ede8695d..f7657f7d6 100644 --- a/os/net/mac/tsch/tsch-conf.h +++ b/os/net/mac/tsch/tsch-conf.h @@ -37,6 +37,11 @@ * Simon Duquennoy */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_CONF_H__ #define __TSCH_CONF_H__ @@ -199,3 +204,4 @@ #endif #endif /* __TSCH_CONF_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-log.c b/os/net/mac/tsch/tsch-log.c index e92311217..9235d9d7d 100644 --- a/os/net/mac/tsch/tsch-log.c +++ b/os/net/mac/tsch/tsch-log.c @@ -40,6 +40,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include #include "net/mac/tsch/tsch.h" @@ -172,3 +177,4 @@ tsch_log_stop(void) } #endif /* TSCH_LOG_PER_SLOT */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-log.h b/os/net/mac/tsch/tsch-log.h index 7c4acd7b4..f73e0ddc4 100644 --- a/os/net/mac/tsch/tsch-log.h +++ b/os/net/mac/tsch/tsch-log.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_LOG_H__ #define __TSCH_LOG_H__ @@ -131,3 +136,4 @@ void tsch_log_stop(void); #endif /* (TSCH_LOG_PER_SLOT == 0) */ #endif /* __TSCH_LOG_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-packet.c b/os/net/mac/tsch/tsch-packet.c index e7c1b6350..2db212dac 100644 --- a/os/net/mac/tsch/tsch-packet.c +++ b/os/net/mac/tsch/tsch-packet.c @@ -38,6 +38,11 @@ * Beshr Al Nahas */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include "net/packetbuf.h" #include "net/mac/tsch/tsch.h" @@ -459,3 +464,4 @@ tsch_packet_parse_eb(const uint8_t *buf, int buf_size, return curr_len; } /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/mac/tsch/tsch-packet.h b/os/net/mac/tsch/tsch-packet.h index b8a001f66..717e0fdda 100644 --- a/os/net/mac/tsch/tsch-packet.h +++ b/os/net/mac/tsch/tsch-packet.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_PACKET_H__ #define __TSCH_PACKET_H__ @@ -103,3 +108,4 @@ int tsch_packet_parse_eb(const uint8_t *buf, int buf_size, uint8_t *hdrlen, int frame_without_mic); #endif /* __TSCH_PACKET_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-private.h b/os/net/mac/tsch/tsch-private.h index 54b6ba436..ec114813e 100644 --- a/os/net/mac/tsch/tsch-private.h +++ b/os/net/mac/tsch/tsch-private.h @@ -39,6 +39,11 @@ * Beshr Al Nahas */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_PRIVATE_H__ #define __TSCH_PRIVATE_H__ @@ -130,3 +135,4 @@ void tsch_disassociate(void); while(!(cond) && RTIMER_CLOCK_LT(RTIMER_NOW(), (t0) + (offset))) ; #endif /* CONTIKI_TARGET_COOJA || CONTIKI_TARGET_COOJA_IP64 */ #endif /* __TSCH_PRIVATE_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-queue.c b/os/net/mac/tsch/tsch-queue.c index 3e940a823..388953a60 100644 --- a/os/net/mac/tsch/tsch-queue.c +++ b/os/net/mac/tsch/tsch-queue.c @@ -42,6 +42,11 @@ * Domenico De Guglielmo */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include "lib/list.h" #include "lib/memb.h" @@ -524,3 +529,4 @@ tsch_queue_init(void) n_broadcast = tsch_queue_add_nbr(&tsch_broadcast_address); } /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/mac/tsch/tsch-queue.h b/os/net/mac/tsch/tsch-queue.h index 31e413def..fad8630c1 100644 --- a/os/net/mac/tsch/tsch-queue.h +++ b/os/net/mac/tsch/tsch-queue.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_QUEUE_H__ #define __TSCH_QUEUE_H__ @@ -196,3 +201,4 @@ void tsch_queue_update_all_backoff_windows(const linkaddr_t *dest_addr); void tsch_queue_init(void); #endif /* __TSCH_QUEUE_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-rpl.c b/os/net/mac/tsch/tsch-rpl.c index a18dfbb3e..ec3f24d8b 100644 --- a/os/net/mac/tsch/tsch-rpl.c +++ b/os/net/mac/tsch/tsch-rpl.c @@ -35,6 +35,11 @@ * \author Simon Duquennoy */ +/** + * \addtogroup tsch + * @{ +*/ + #if UIP_CONF_IPV6_RPL #include "contiki.h" @@ -135,3 +140,4 @@ tsch_rpl_callback_parent_switch(rpl_parent_t *old, rpl_parent_t *new) } } #endif /* UIP_CONF_IPV6_RPL */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-rpl.h b/os/net/mac/tsch/tsch-rpl.h index d468e3d17..15be760f5 100644 --- a/os/net/mac/tsch/tsch-rpl.h +++ b/os/net/mac/tsch/tsch-rpl.h @@ -28,6 +28,10 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ #ifndef __TSCH_RPL_H__ #define __TSCH_RPL_H__ @@ -60,3 +64,4 @@ void tsch_rpl_callback_new_dio_interval(clock_time_t dio_interval); void tsch_rpl_callback_parent_switch(rpl_parent_t *old, rpl_parent_t *new); #endif /* __TSCH_RPL_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-schedule.c b/os/net/mac/tsch/tsch-schedule.c index a0a56147b..dd31afecd 100644 --- a/os/net/mac/tsch/tsch-schedule.c +++ b/os/net/mac/tsch/tsch-schedule.c @@ -38,6 +38,11 @@ * Beshr Al Nahas */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include "dev/leds.h" #include "lib/memb.h" @@ -468,3 +473,4 @@ tsch_schedule_print(void) } } /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/mac/tsch/tsch-schedule.h b/os/net/mac/tsch/tsch-schedule.h index 1099664a9..206b40aab 100644 --- a/os/net/mac/tsch/tsch-schedule.h +++ b/os/net/mac/tsch/tsch-schedule.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_SCHEDULE_H__ #define __TSCH_SCHEDULE_H__ @@ -165,3 +170,4 @@ struct tsch_slotframe *tsch_schedule_slotframe_head(void); struct tsch_slotframe *tsch_schedule_slotframe_next(struct tsch_slotframe *sf); #endif /* __TSCH_SCHEDULE_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-security.c b/os/net/mac/tsch/tsch-security.c index b132e5882..d53dd9307 100644 --- a/os/net/mac/tsch/tsch-security.c +++ b/os/net/mac/tsch/tsch-security.c @@ -37,6 +37,11 @@ * Simon Duquennoy */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include "net/mac/tsch/tsch.h" #include "net/mac/tsch/tsch-packet.h" @@ -267,3 +272,4 @@ tsch_security_parse_frame(const uint8_t *hdr, int hdrlen, int datalen, return 1; } } +/** @} */ diff --git a/os/net/mac/tsch/tsch-security.h b/os/net/mac/tsch/tsch-security.h index 7652a72bf..4ca4be07e 100644 --- a/os/net/mac/tsch/tsch-security.h +++ b/os/net/mac/tsch/tsch-security.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_SECURITY_H__ #define __TSCH_SECURITY_H__ @@ -139,3 +144,4 @@ unsigned int tsch_security_parse_frame(const uint8_t *hdr, int hdrlen, struct tsch_asn_t *asn); #endif /* __TSCH_SECURITY_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch-slot-operation.c b/os/net/mac/tsch/tsch-slot-operation.c index 715b9463d..3596b913c 100644 --- a/os/net/mac/tsch/tsch-slot-operation.c +++ b/os/net/mac/tsch/tsch-slot-operation.c @@ -40,6 +40,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #include "dev/radio.h" #include "contiki.h" #include "net/netstack.h" @@ -1061,3 +1066,4 @@ tsch_slot_operation_sync(rtimer_clock_t next_slot_start, current_link = NULL; } /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/mac/tsch/tsch-slot-operation.h b/os/net/mac/tsch/tsch-slot-operation.h index 74e054b55..0c0ae60b6 100644 --- a/os/net/mac/tsch/tsch-slot-operation.h +++ b/os/net/mac/tsch/tsch-slot-operation.h @@ -30,6 +30,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #ifndef __TSCH_SLOT_OPERATION_H__ #define __TSCH_SLOT_OPERATION_H__ @@ -124,3 +129,4 @@ void tsch_slot_operation_sync(rtimer_clock_t next_slot_start, void tsch_slot_operation_start(void); #endif /* __TSCH_SLOT_OPERATION_H__ */ +/** @} */ diff --git a/os/net/mac/tsch/tsch.c b/os/net/mac/tsch/tsch.c index f7b60f020..ba57c981e 100644 --- a/os/net/mac/tsch/tsch.c +++ b/os/net/mac/tsch/tsch.c @@ -40,6 +40,11 @@ * */ +/** + * \addtogroup tsch + * @{ +*/ + #include "contiki.h" #include "dev/radio.h" #include "net/netstack.h" @@ -1092,3 +1097,4 @@ const struct mac_driver tschmac_driver = { turn_off }; /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/mac/tsch/tsch.h b/os/net/mac/tsch/tsch.h index 9516e09c8..c93d2d460 100644 --- a/os/net/mac/tsch/tsch.h +++ b/os/net/mac/tsch/tsch.h @@ -30,6 +30,15 @@ * */ +/** +* \ingroup link-layer +* \defgroup tsch 802.15.4 TSCH +The IEEE 802.15.4-2015 TimeSlotted Channel Hopping (TSCH) protocol. Provides +scheduled communication on top of a globally-synchronized network. Performs +frequency hopping for enhanced reliability. +* @{ +*/ + #ifndef __TSCH_H__ #define __TSCH_H__ @@ -189,3 +198,4 @@ void tsch_set_coordinator(int enable); void tsch_set_pan_secured(int enable); #endif /* __TSCH_H__ */ +/** @} */ diff --git a/os/net/nullnet/nullnet.h b/os/net/nullnet/nullnet.h index d710dc498..8f8bc9151 100644 --- a/os/net/nullnet/nullnet.h +++ b/os/net/nullnet/nullnet.h @@ -39,7 +39,10 @@ */ /** + * \ingroup net-layer * \addtogroup nullnet +A network layer that does nothing. Useful for lower-layer testing and +for non-IPv6 scenarios. * @{ */ @@ -49,10 +52,26 @@ #include "contiki.h" #include "net/linkaddr.h" +/** + * Function prototype for NullNet input callback +*/ typedef void (* nullnet_input_callback)(const void *data, uint16_t len, const linkaddr_t *src, const linkaddr_t *dest); +/** + * Set input callback for NullNet + * + * \param callback The input callback +*/ void nullnet_set_input_callback(nullnet_input_callback callback); + +/** + * Send data with NullNet + * + * \param data The payload + * \param len The payload len + * \param dest The destination link-layer address +*/ void nullnet_output(const void *data, uint16_t len, const linkaddr_t *dest); #endif /* NULLNET_H_ */ diff --git a/os/net/packetbuf.h b/os/net/packetbuf.h index 8452e3c57..c16a3f8f1 100644 --- a/os/net/packetbuf.h +++ b/os/net/packetbuf.h @@ -38,12 +38,12 @@ */ /** - * \addtogroup netstack + * \addtogroup net * @{ */ /** - * \defgroup packetbuf Packet buffer management + * \defgroup packetbuf Packet buffer * @{ * * The packetbuf module does Contiki's buffer management. diff --git a/os/net/queuebuf.h b/os/net/queuebuf.h index 3c9784711..60216465d 100644 --- a/os/net/queuebuf.h +++ b/os/net/queuebuf.h @@ -38,12 +38,12 @@ */ /** - * \addtogroup netstack + * \addtogroup net * @{ */ /** - * \defgroup queuebuf Packet queue buffer management + * \defgroup queuebuf Packet buffer queue * @{ * * The queuebuf module handles buffers that are queued. diff --git a/os/net/rpl-classic/rpl-dag.c b/os/net/rpl-classic/rpl-dag.c index 506b55ac7..e4f4191b1 100644 --- a/os/net/rpl-classic/rpl-dag.c +++ b/os/net/rpl-classic/rpl-dag.c @@ -39,7 +39,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-ext-header.c b/os/net/rpl-classic/rpl-ext-header.c index 32b658df9..aa0260aae 100644 --- a/os/net/rpl-classic/rpl-ext-header.c +++ b/os/net/rpl-classic/rpl-ext-header.c @@ -40,7 +40,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-icmp6.c b/os/net/rpl-classic/rpl-icmp6.c index c4f8041fe..6da3c2656 100644 --- a/os/net/rpl-classic/rpl-icmp6.c +++ b/os/net/rpl-classic/rpl-icmp6.c @@ -41,7 +41,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-mrhof.c b/os/net/rpl-classic/rpl-mrhof.c index 635ffebd9..21db377e7 100644 --- a/os/net/rpl-classic/rpl-mrhof.c +++ b/os/net/rpl-classic/rpl-mrhof.c @@ -42,7 +42,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-nbr-policy.c b/os/net/rpl-classic/rpl-nbr-policy.c index d02dad52f..1804fd4b7 100644 --- a/os/net/rpl-classic/rpl-nbr-policy.c +++ b/os/net/rpl-classic/rpl-nbr-policy.c @@ -28,7 +28,7 @@ * */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-of0.c b/os/net/rpl-classic/rpl-of0.c index dd41fd58a..aa18823cb 100644 --- a/os/net/rpl-classic/rpl-of0.c +++ b/os/net/rpl-classic/rpl-of0.c @@ -38,7 +38,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl-timers.c b/os/net/rpl-classic/rpl-timers.c index bb1c769c8..b89a1258d 100644 --- a/os/net/rpl-classic/rpl-timers.c +++ b/os/net/rpl-classic/rpl-timers.c @@ -37,7 +37,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-classic/rpl.c b/os/net/rpl-classic/rpl.c index 9f2a31e50..dfa7c99cf 100644 --- a/os/net/rpl-classic/rpl.c +++ b/os/net/rpl-classic/rpl.c @@ -38,7 +38,7 @@ */ /** - * \addtogroup uip6 + * \addtogroup uip * @{ */ diff --git a/os/net/rpl-lite/rpl-conf.h b/os/net/rpl-lite/rpl-conf.h index 6bf29219b..ed69b86d6 100644 --- a/os/net/rpl-lite/rpl-conf.h +++ b/os/net/rpl-lite/rpl-conf.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * Public configuration and API declarations for ContikiRPL. * \author @@ -379,4 +382,6 @@ #define RPL_PREFERENCE 0 #endif +/** @} */ + #endif /* RPL_CONF_H */ diff --git a/os/net/rpl-lite/rpl-const.h b/os/net/rpl-lite/rpl-const.h index 9a3ae11a2..4bf6c1e4f 100644 --- a/os/net/rpl-lite/rpl-const.h +++ b/os/net/rpl-lite/rpl-const.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * Constants for RPL * \author @@ -40,7 +43,7 @@ #define RPL_CONST_H /** - * \addtogroup uip6 + * \addtogroup rpl-lite * @{ */ diff --git a/os/net/rpl-lite/rpl-dag-root.c b/os/net/rpl-lite/rpl-dag-root.c index 58af56e28..cfe227d4c 100644 --- a/os/net/rpl-lite/rpl-dag-root.c +++ b/os/net/rpl-lite/rpl-dag-root.c @@ -29,6 +29,14 @@ * */ +/** +* \addtogroup rpl-lite +* @{ +* +* \file +* DAG root utility functions for RPL. +*/ + #include "contiki.h" #include "contiki-net.h" @@ -180,3 +188,4 @@ rpl_dag_root_is_root(void) return curr_instance.used && curr_instance.dag.rank == ROOT_RANK; } /*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/os/net/rpl-lite/rpl-dag-root.h b/os/net/rpl-lite/rpl-dag-root.h index a1225d5d1..d6260ff21 100644 --- a/os/net/rpl-lite/rpl-dag-root.h +++ b/os/net/rpl-lite/rpl-dag-root.h @@ -33,9 +33,12 @@ #define RPL_DAG_ROOT_H_ /** - * \addtogroup uip6 - * @{ - */ +* \addtogroup rpl-lite +* @{ +* +* \file +* DAG root utility functions for RPL. +*/ /********** Public functions **********/ diff --git a/os/net/rpl-lite/rpl-dag.c b/os/net/rpl-lite/rpl-dag.c index bf084acb7..6db878844 100644 --- a/os/net/rpl-lite/rpl-dag.c +++ b/os/net/rpl-lite/rpl-dag.c @@ -31,6 +31,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * Logic for Directed Acyclic Graphs in RPL. * @@ -39,11 +42,6 @@ * Contributors: George Oikonomou (multicast) */ -/** - * \addtogroup uip6 - * @{ - */ - #include "net/rpl-lite/rpl.h" #include "net/nbr-table.h" #include "net/link-stats.h" diff --git a/os/net/rpl-lite/rpl-dag.h b/os/net/rpl-lite/rpl-dag.h index 07ef3ca66..c3e22ae54 100644 --- a/os/net/rpl-lite/rpl-dag.h +++ b/os/net/rpl-lite/rpl-dag.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * Header file for rpl-dag module * \author @@ -43,11 +46,6 @@ #include "uip.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Public functions **********/ /** diff --git a/os/net/rpl-lite/rpl-ext-header.c b/os/net/rpl-lite/rpl-ext-header.c index 512761689..878797c8b 100644 --- a/os/net/rpl-lite/rpl-ext-header.c +++ b/os/net/rpl-lite/rpl-ext-header.c @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * Management of extension headers for ContikiRPL. * @@ -39,12 +42,7 @@ * Nicolas Tsiftes , * Simon Duquennoy */ - -/** - * \addtogroup uip6 - * @{ - */ - + #include "net/rpl-lite/rpl.h" #include "net/packetbuf.h" diff --git a/os/net/rpl-lite/rpl-ext-header.h b/os/net/rpl-lite/rpl-ext-header.h index 6da393506..3e339e6e2 100644 --- a/os/net/rpl-lite/rpl-ext-header.h +++ b/os/net/rpl-lite/rpl-ext-header.h @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * Header file for rpl-ext-header * @@ -39,11 +42,6 @@ #ifndef RPL_EXT_HEADER_H_ #define RPL_EXT_HEADER_H_ -/** - * \addtogroup uip6 - * @{ - */ - /********** Public functions **********/ /** diff --git a/os/net/rpl-lite/rpl-icmp6.c b/os/net/rpl-lite/rpl-icmp6.c index a150afced..65c486be5 100644 --- a/os/net/rpl-lite/rpl-icmp6.c +++ b/os/net/rpl-lite/rpl-icmp6.c @@ -31,6 +31,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * ICMP6 I/O for RPL control messages. * @@ -41,11 +44,6 @@ * George Oikonomou (multicast) */ -/** - * \addtogroup uip6 - * @{ - */ - #include "net/rpl-lite/rpl.h" #include "net/ipv6/uip-icmp6.h" #include "net/packetbuf.h" diff --git a/os/net/rpl-lite/rpl-icmp6.h b/os/net/rpl-lite/rpl-icmp6.h index a89cad945..443d28ef6 100644 --- a/os/net/rpl-lite/rpl-icmp6.h +++ b/os/net/rpl-lite/rpl-icmp6.h @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * Header file for rpl-ext-header * @@ -42,11 +45,6 @@ #include "uip.h" #include "uip-ds6.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Data structures **********/ /* Logical representation of a DAG Information Object (DIO.) */ diff --git a/os/net/rpl-lite/rpl-mrhof.c b/os/net/rpl-lite/rpl-mrhof.c index faab5ce51..9f9ba2889 100644 --- a/os/net/rpl-lite/rpl-mrhof.c +++ b/os/net/rpl-lite/rpl-mrhof.c @@ -31,6 +31,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * The Minimum Rank with Hysteresis Objective Function (MRHOF), RFC6719 * @@ -42,11 +45,6 @@ * Simon Duquennoy */ -/** - * \addtogroup uip6 - * @{ - */ - #include "net/rpl-lite/rpl.h" #include "net/nbr-table.h" #include "net/link-stats.h" diff --git a/os/net/rpl-lite/rpl-nbr-policy.c b/os/net/rpl-lite/rpl-nbr-policy.c index b25c92d22..0a8da44d4 100644 --- a/os/net/rpl-lite/rpl-nbr-policy.c +++ b/os/net/rpl-lite/rpl-nbr-policy.c @@ -27,13 +27,11 @@ * SUCH DAMAGE. * */ + /** - * \addtogroup uip6 + * \addtogroup rpl-lite * @{ - */ - - -/** + * * \file * * Default RPL NBR policy diff --git a/os/net/rpl-lite/rpl-neighbor.c b/os/net/rpl-lite/rpl-neighbor.c index ad128d163..96c85a886 100644 --- a/os/net/rpl-lite/rpl-neighbor.c +++ b/os/net/rpl-lite/rpl-neighbor.c @@ -31,6 +31,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * Logic for DAG neighbors in RPL. * @@ -39,10 +42,6 @@ * Contributors: George Oikonomou (multicast) */ -/** - * \addtogroup uip6 - * @{ - */ #include "contiki.h" #include "net/rpl-lite/rpl.h" #include "net/link-stats.h" diff --git a/os/net/rpl-lite/rpl-neighbor.h b/os/net/rpl-lite/rpl-neighbor.h index fae51c072..e81c5bcc6 100644 --- a/os/net/rpl-lite/rpl-neighbor.h +++ b/os/net/rpl-lite/rpl-neighbor.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * Header file for rpl-neighbor module * \author @@ -47,11 +50,6 @@ #include "net/ipv6/uip-ds6.h" #include "sys/ctimer.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Public symbols **********/ /* Per-neighbor RPL information. According to RFC 6550, there exist three diff --git a/os/net/rpl-lite/rpl-ns.c b/os/net/rpl-lite/rpl-ns.c index c6f4dfe5d..1bd72f368 100644 --- a/os/net/rpl-lite/rpl-ns.c +++ b/os/net/rpl-lite/rpl-ns.c @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * RPL non-storing mode specific functions. Includes support for * source routing. @@ -248,3 +251,4 @@ rpl_ns_free_all(void) num_nodes--; } } +/** @} */ diff --git a/os/net/rpl-lite/rpl-ns.h b/os/net/rpl-lite/rpl-ns.h index 882db432e..5f6e3d86d 100644 --- a/os/net/rpl-lite/rpl-ns.h +++ b/os/net/rpl-lite/rpl-ns.h @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * RPL non-storing mode specific functions. Includes support for * source routing. @@ -46,11 +49,6 @@ #include "net/ipv6/uip.h" #include "net/rpl-lite/rpl.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Data Structures **********/ /* A node in a RPL Non-storing graph, stored at the root and representing diff --git a/os/net/rpl-lite/rpl-of0.c b/os/net/rpl-lite/rpl-of0.c index f35cc53cb..0e94f73f9 100644 --- a/os/net/rpl-lite/rpl-of0.c +++ b/os/net/rpl-lite/rpl-of0.c @@ -31,6 +31,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * An implementation of RPL's objective function 0, RFC6552 * @@ -38,11 +41,6 @@ * Simon Duquennoy */ -/** - * \addtogroup uip6 - * @{ - */ - #include "net/rpl-lite/rpl.h" #include "net/nbr-table.h" #include "net/link-stats.h" diff --git a/os/net/rpl-lite/rpl-timers.c b/os/net/rpl-lite/rpl-timers.c index c0f09e47b..486ccd5b4 100644 --- a/os/net/rpl-lite/rpl-timers.c +++ b/os/net/rpl-lite/rpl-timers.c @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * RPL timer management. * @@ -37,11 +40,6 @@ * Simon Duquennoy */ -/** - * \addtogroup uip6 - * @{ - */ - #include "contiki.h" #include "net/rpl-lite/rpl.h" #include "net/link-stats.h" diff --git a/os/net/rpl-lite/rpl-timers.h b/os/net/rpl-lite/rpl-timers.h index 136e2f7ed..a37d5df36 100644 --- a/os/net/rpl-lite/rpl-timers.h +++ b/os/net/rpl-lite/rpl-timers.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * Header file for rpl-timers module * \author @@ -43,11 +46,6 @@ #include "net/rpl-lite/rpl.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Public functions **********/ /** diff --git a/os/net/rpl-lite/rpl-types.h b/os/net/rpl-lite/rpl-types.h index 710ef69c2..53856f66d 100644 --- a/os/net/rpl-lite/rpl-types.h +++ b/os/net/rpl-lite/rpl-types.h @@ -28,6 +28,9 @@ * * This file is part of the Contiki operating system. * + * \addtogroup rpl-lite + * @{ + * * \file * RPL types and macros * \author @@ -39,11 +42,6 @@ #ifndef RPL_TYPES_H #define RPL_TYPES_H -/** - * \addtogroup uip6 - * @{ - */ - /********** Macros **********/ /* Multicast address: create and compare */ diff --git a/os/net/rpl-lite/rpl.c b/os/net/rpl-lite/rpl.c index e698ca990..76d49d562 100644 --- a/os/net/rpl-lite/rpl.c +++ b/os/net/rpl-lite/rpl.c @@ -30,6 +30,9 @@ */ /** + * \addtogroup rpl-lite + * @{ + * * \file * ContikiRPL, an implementation of RPL: IPv6 Routing Protocol * for Low-Power and Lossy Networks (IETF RFC 6550) @@ -38,11 +41,6 @@ * Simon Duquennoy */ -/** - * \addtogroup uip6 - * @{ - */ - #include "net/rpl-lite/rpl.h" /* Log configuration */ diff --git a/os/net/rpl-lite/rpl.h b/os/net/rpl-lite/rpl.h index 10e3e941b..9557f41c3 100644 --- a/os/net/rpl-lite/rpl.h +++ b/os/net/rpl-lite/rpl.h @@ -28,6 +28,12 @@ * * This file is part of the Contiki operating system. * + * \ingroup net-layer + * \addtogroup rpl-lite + RPL-lite is a lightweight implementation of RPL tailored for reliability. + Supports only non-storing mode, one instance and one DAG. + * @{ + * * \file * Public API declarations for RPL. * \author @@ -53,11 +59,6 @@ #include "net/rpl-lite/rpl-ext-header.h" #include "net/rpl-lite/rpl-timers.h" -/** - * \addtogroup uip6 - * @{ - */ - /********** Public symbols **********/ /* The only instance */ diff --git a/os/services/shell/shell.c b/os/services/shell/shell.c index 54356db5c..f10852414 100644 --- a/os/services/shell/shell.c +++ b/os/services/shell/shell.c @@ -38,7 +38,10 @@ */ /** - * \addtogroup shell + * \addtogroup shell Shell + The shell enables to inspect and manage the network layer and provides + other system functionalities + * \ingroup lib * @{ */ diff --git a/os/sys/clock.h b/os/sys/clock.h index 9aa2b79c8..3aa25b22c 100644 --- a/os/sys/clock.h +++ b/os/sys/clock.h @@ -32,7 +32,7 @@ * */ -/** \addtogroup sys +/** \addtogroup timers * @{ */ diff --git a/os/sys/ctimer.h b/os/sys/ctimer.h index 0bdbb07b0..2d391a5e5 100644 --- a/os/sys/ctimer.h +++ b/os/sys/ctimer.h @@ -38,7 +38,7 @@ */ /** - * \addtogroup sys + * \addtogroup timers * @{ */ diff --git a/os/sys/etimer.h b/os/sys/etimer.h index 438196709..59f665d10 100644 --- a/os/sys/etimer.h +++ b/os/sys/etimer.h @@ -39,7 +39,7 @@ * Adam Dunkels */ -/** \addtogroup sys +/** \addtogroup timers * @{ */ /** diff --git a/os/sys/mt.h b/os/sys/mt.h index b472b3197..abe04d12e 100644 --- a/os/sys/mt.h +++ b/os/sys/mt.h @@ -32,7 +32,7 @@ * */ -/** \addtogroup sys +/** \addtogroup threads * @{ */ @@ -46,12 +46,6 @@ * the same for all platforms on which Contiki runs, and a platform * specific part, which must be implemented specifically for the * platform that the multi-threading library should run. - * - * @{ - */ - -/** - * \defgroup mtarch Architecture support for multi-threading * @{ * * The Contiki multi-threading library requires some architecture @@ -258,6 +252,5 @@ void mt_exit(void); */ void mt_stop(struct mt_thread *thread); -/** @} */ /** @} */ #endif /* MT_H_ */ diff --git a/os/sys/process.h b/os/sys/process.h index 2d15ca89c..bd206b6e7 100644 --- a/os/sys/process.h +++ b/os/sys/process.h @@ -31,14 +31,14 @@ */ /** - * \addtogroup sys + * \addtogroup threads * @{ */ /** * \defgroup process Contiki processes * - * A process in Contiki consists of a single \ref pt "protothread". + * A process in Contiki consists of a single protothread. * * @{ */ diff --git a/os/sys/rtimer.h b/os/sys/rtimer.h index e9cb16091..95d11c33d 100644 --- a/os/sys/rtimer.h +++ b/os/sys/rtimer.h @@ -38,7 +38,7 @@ * */ -/** \addtogroup sys +/** \addtogroup threads * @{ */ /** diff --git a/os/sys/stimer.h b/os/sys/stimer.h index 6ef7db5de..bf238987f 100644 --- a/os/sys/stimer.h +++ b/os/sys/stimer.h @@ -39,7 +39,7 @@ * Adam Dunkels , Nicolas Tsiftes */ -/** \addtogroup sys +/** \addtogroup timers * @{ */ /** diff --git a/os/sys/subprocess.h b/os/sys/subprocess.h index ebb95501e..0031dcebd 100644 --- a/os/sys/subprocess.h +++ b/os/sys/subprocess.h @@ -31,7 +31,7 @@ */ /** - * \addtogroup sys + * \addtogroup threads * @{ */ diff --git a/os/sys/timer.h b/os/sys/timer.h index 969137507..b05963e47 100644 --- a/os/sys/timer.h +++ b/os/sys/timer.h @@ -39,16 +39,12 @@ * Adam Dunkels */ -/** \addtogroup sys +/** \addtogroup timers * @{ */ /** * \defgroup timer Timer library * - * The Contiki kernel does not provide support for timed - * events. Rather, an application that wants to use timers needs to - * explicitly use the timer library. - * * The timer library provides functions for setting, resetting and * restarting timers, and for checking if a timer has expired. An * application must "manually" check if its timers have expired; this