giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #80 from sics-iot/pr/doxygen-modules

Browse Source 
Rework Doxygen modules
This commit is contained in:
Simon Duquennoy 2017-10-02 14:13:43 +02:00 committed by GitHub
commit c43da309d0
149 changed files with 471 additions and 345 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
arch/cpu/arm/common/CMSIS/core_cm0.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_cm0plus.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_cm3.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_cm4.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_cm7.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_sc000.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/arm/common/CMSIS/core_sc300.h
View File

@ -48,7 +48,7 @@
#endif #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: CMSIS violates the following MISRA-C:2004 rules:
\li Required Rule 8.5, object/function definition in header file.<br> \li Required Rule 8.5, object/function definition in header file.<br>

2
arch/cpu/cc26xx-cc13xx/clock.c
View File

@ -32,7 +32,7 @@
* \addtogroup platform * \addtogroup platform
* @{ * @{
* *
* \defgroup cc26xx-platforms TI CC26xx-powered Platforms * \defgroup cc26xx-platforms TI CC26xx-powered platforms
* @{ * @{
* *
* \defgroup cc26xx The TI CC26xx and CC13xx CPUs * \defgroup cc26xx The TI CC26xx and CC13xx CPUs

2
arch/cpu/nrf52832/ble/ble-core.c
View File

@ -28,7 +28,7 @@
* *
*/ */
/** /**
* \addtogroup cpu * \addtogroup dev
* @{ * @{
* *
* \addtogroup nrf52832 * \addtogroup nrf52832

2
arch/cpu/nrf52832/ble/ble-core.h
View File

@ -28,7 +28,7 @@
* *
*/ */
/** /**
* \addtogroup cpu * \addtogroup dev
* @{ * @{
* *
* \addtogroup nrf52832 * \addtogroup nrf52832

2
arch/cpu/nrf52832/rtimer-arch.h
View File

@ -28,7 +28,7 @@
* *
*/ */
/** /**
* \addtogroup nrf52832 nRF52832 * \addtogroup nrf52832
* @{ * @{
* *
* \file * \file

4
arch/platform/sky/doc/sky.txt
View File

@ -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 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 an MSP430-based board with an 802.15.4-compatible CC2420 radio chip, a
1 megabyte external serial flash memory, and two light 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 of the RUNES project. The Tmote Sky port was integrated into the
Contiki build system in March 2007. Contiki build system in March 2007.

4
arch/platform/zoul/contiki-conf.h
View File

@ -29,10 +29,10 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * 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 * 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 * products. Its small size and module format eases to place in different PCB

2
arch/platform/zoul/dev/antenna-sw.h
View File

@ -28,7 +28,7 @@
*/ */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** /**
* \addtogroup remote * \addtogroup zoul
* @{ * @{
* *
* \defgroup remote-antenna RE-Mote Antenna switch * \defgroup remote-antenna RE-Mote Antenna switch

3
arch/platform/zoul/dev/bme280-arch.c
View File

@ -31,6 +31,8 @@
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \addtogroup zoul-bme280-sensor * \addtogroup zoul-bme280-sensor
* \ingroup zoul
*
* @{ * @{
* *
* \file * \file
@ -75,4 +77,3 @@ bme280_arch_i2c_read_mem(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t bytes)
/** /**
* @} * @}
*/ */

1
arch/platform/zoul/dev/mmc-arch.c
View File

@ -30,6 +30,7 @@
*/ */
/** /**
* \addtogroup mmc-arch * \addtogroup mmc-arch
* \ingroup zoul
* @{ * @{
* *
* \file * \file

2
arch/platform/zoul/dev/rtcc.h
View File

@ -31,7 +31,7 @@
*/ */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** /**
* \addtogroup remote * \addtogroup zoul
* @{ * @{
* *
* \defgroup remote-rtcc RE-Mote Real Time Clock Calendar * \defgroup remote-rtcc RE-Mote Real Time Clock Calendar

4
arch/platform/zoul/firefly-reva/board.h
View File

@ -33,7 +33,7 @@
* \addtogroup zoul-platforms * \addtogroup zoul-platforms
* @{ * @{
* *
* \defgroup firefly-reva Firefly platform * \addtogroup firefly
* *
* The Zolertia Firefly is the most down-to-core development platform, exposing * 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 * the Zoul core functionalities and features, with a slick design to allow a
@ -272,7 +272,7 @@
*/ */
#ifdef PLATFORM_CONF_WITH_BUTTON #ifdef PLATFORM_CONF_WITH_BUTTON
#if (PLATFORM_CONF_WITH_BUTTON && (ADC_SENSORS_ADC6_PIN == 3)) #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 #else
#define PLATFORM_HAS_BUTTON (PLATFORM_CONF_WITH_BUTTON && \ #define PLATFORM_HAS_BUTTON (PLATFORM_CONF_WITH_BUTTON && \
!(ADC_SENSORS_ADC6_PIN == 3)) !(ADC_SENSORS_ADC6_PIN == 3))

2
arch/platform/zoul/fs/fat/ffconf.h
View File

@ -33,7 +33,7 @@
* POSSIBILITY OF SUCH DAMAGE. * POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup remote * \addtogroup zoul
* @{ * @{
* *
* \defgroup remote-fat RE-Mote FatFs * \defgroup remote-fat RE-Mote FatFs

2
arch/platform/zoul/remote-reva/power-mgmt.h
View File

@ -29,7 +29,7 @@
*/ */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \addtogroup remote * \addtogroup remote-reva
* @{ * @{
* *
* \defgroup remote-power-mgmt-reva RE-Mote power management driver * \defgroup remote-power-mgmt-reva RE-Mote power management driver

2
arch/platform/zoul/remote-revb/power-mgmt.h
View File

@ -29,7 +29,7 @@
*/ */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \addtogroup remote * \addtogroup remote-revb
* @{ * @{
* *
* \defgroup remote-power-mgmt-revb RE-Mote power management driver * \defgroup remote-power-mgmt-revb RE-Mote power management driver

8
doc/Doxyfile
View File

@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # 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 # 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 # 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 # "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines. # newlines.
ALIASES = "os=New Contiki" ALIASES = "os=Contiki-NG"
# This tag can be used to specify a number of word-keyword mappings (TCL only). # 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" # 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. # appear in their defined order.
# The default value is: NO. # 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 # 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 # 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 # that contain images that are to be included in the documentation (see the
# \image command). # \image command).
IMAGE_PATH = pics # IMAGE_PATH = pics
# The INPUT_FILTER tag can be used to specify a program that doxygen should # 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 # invoke to filter for each input file. Doxygen will invoke the filter program

13
doc/apps.txt
View File

@ -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
*
* @{ */
/** @} */

9
doc/build-system.txt
View File

@ -1,6 +1,7 @@
/** /**
\ingroup tutorials
\defgroup buildsystem The \os build system \defgroup buildsystem The \os build system
The \os build system is designed to make it easy to compile The \os build system is designed to make it easy to compile
\os applications for either to a hardware platform or into a \os applications for either to a hardware platform or into a
simulation platform by simply supplying different parameters to the simulation platform by simply supplying different parameters to the
@ -17,7 +18,7 @@
development system. After compiling the application for the development system. After compiling the application for the
<tt>native</tt> target it is possible to run the \os system with <tt>native</tt> target it is possible to run the \os system with
the application by running the file <tt>hello-world.native</tt>. the application by running the file <tt>hello-world.native</tt>.
To compile the hello-world application into a stand-alone executable To compile the hello-world application into a stand-alone executable
that can be loaded into a running \os system, the command that can be loaded into a running \os system, the command
<tt>make hello-world.ce</tt> is used. To build an executable file for <tt>make hello-world.ce</tt> is used. To build an executable file for
@ -31,7 +32,7 @@
saved in the project's directory. saved in the project's directory.
\section buildsystem-makefiles Makefiles used in the \os build system \section buildsystem-makefiles Makefiles used in the \os build system
The \os build system is composed of a number of Makefiles. These The \os build system is composed of a number of Makefiles. These
are: are:
- <tt>Makefile</tt>: the project's makefile, located in the project directory. - <tt>Makefile</tt>: 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 First, the location of the \os source code tree is given by
defining the <tt>CONTIKI</tt> variable. Next, the name of the defining the <tt>CONTIKI</tt> variable. Next, the name of the
application is defined. Finally, the system-wide application is defined. Finally, the system-wide
<tt>Makefile.include</tt> is included. <tt>Makefile.include</tt> is included.
The <tt>Makefile.include</tt> contains definitions of the C files of The <tt>Makefile.include</tt> contains definitions of the C files of
the core \os system. <tt>Makefile.include</tt> always reside in the core \os system. <tt>Makefile.include</tt> always reside in

3
doc/code-style.txt
View File

@ -1,3 +0,0 @@
/**
\example code-style.c
*/

50
doc/cpu.txt
View File

@ -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
*/

5
doc/dev.txt
View File

@ -1,5 +0,0 @@
/**
\defgroup dev Device driver APIs
@{
*/
/** @} */

5
doc/lib.txt
View File

@ -1,5 +0,0 @@
/**
\defgroup lib Libraries
@{
*/
/** @} */

2
doc/mainpage.txt
View File

@ -83,6 +83,6 @@ functionality, including memory management and data structures.
\sa \ref heapmem "Heap memory allocator" \sa \ref heapmem "Heap memory allocator"
\sa \ref list "Linked list library" \sa \ref list "Linked list library"
\sa \ref ringbuf "Ring buffer library" \sa \ref ringbuf "Ring buffer library"
\sa \ref trickle-timer "Trickle timers" \sa \ref trickle-timer "Trickle timer"
*/ */

4
doc/mem.txt
View File

@ -1,4 +0,0 @@
/**
\defgroup mem Memory functions
\ingroup lib
*/

123
doc/modules.txt Normal file
View File

@ -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
*/

5
doc/net.txt
View File

@ -1,5 +0,0 @@
/**
\defgroup net IoT networking
@{
*/
/** @} */

BIN
doc/pics/caution.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 982 B

BIN
doc/pics/contiki_menu_3290.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 26 KiB

BIN
doc/pics/dataframe.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 6.2 KiB

BIN
doc/pics/fcf.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/pics/layers.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 9.3 KiB

BIN
doc/pics/raven.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 166 KiB

BIN
doc/pics/raven.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
doc/pics/raven3290p.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/pics/raven_detail.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 50 KiB

BIN
doc/pics/ravenusb_large.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 56 KiB

BIN
doc/pics/ravenusb_medium.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 23 KiB

BIN
doc/pics/ravenusb_network_connections.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 46 KiB

BIN
doc/pics/ravenusb_shortpins.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 64 KiB

BIN
doc/pics/tutorial-raven-basic.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 60 KiB

BIN
doc/pics/tutorial-raven-connections.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 56 KiB

BIN
doc/pics/tutorial-raven-jtag.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 59 KiB

BIN
doc/pics/wireshark_color.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 158 KiB

BIN
doc/pics/wireshark_explained.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 184 KiB

33
doc/platform.txt
View File

@ -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
*/

28
doc/pt-doc.txt
View File

@ -1,10 +1,10 @@
/** /**
\addtogroup sys \addtogroup threads
@{ @{
*/ */
/** /**
\defgroup pt Protothreads \defgroup pt Protothreads
Protothreads are a type of lightweight stackless threads designed for Protothreads are a type of lightweight stackless threads designed for
severly memory constrained systems such as deeply embedded systems or 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 - No machine specific code - the protothreads library is pure C
- Does not use error-prone functions such as longjmp() - Does not use error-prone functions such as longjmp()
- Very small RAM overhead - only two bytes per protothread - Very small RAM overhead - only two bytes per protothread
- Can be used with or without an OS - Can be used with or without an OS
- Provides blocking wait without full multi-threading or - Provides blocking wait without full multi-threading or
stack-switching stack-switching
Examples applications: Examples applications:
- Memory constrained systems - Memory constrained systems
- Event-driven protocol stacks - Event-driven protocol stacks
- Deeply embedded systems - Deeply embedded systems
- Sensor network nodes - Sensor network nodes
The protothreads API consists of four basic operations: 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(). PT_WAIT_WHILE() and protothread blocking: PT_WAIT_THREAD().
\sa \ref pt "Protothreads API documentation" \sa \ref pt "Protothreads API documentation"
The protothreads library is released under a BSD-style license that The protothreads library is released under a BSD-style license that
allows for both non-commercial and commercial usage. The only allows for both non-commercial and commercial usage. The only
requirement is that credit is given. requirement is that credit is given.
@ -123,7 +123,7 @@ generators provide multiple exit points from a generator function.
\section pt-autovars Local variables \section pt-autovars Local variables
\note \note
Because protothreads do not save the stack context across a blocking Because protothreads do not save the stack context across a blocking
call, local variables are not preserved when the protothread call, local variables are not preserved when the protothread
blocks. This means that local variables should be used with utmost 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 machine specific assembler code,
-# by using standard C constructs, or -# 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, The first way works by saving and restoring the processor state,
except for stack pointers, and requires between 16 and 32 bytes of 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 purpose. With this implementation, protothreads require 4 bytes of RAM
per protothread. per protothread.
@{ @{
*/ */
/** @} */ /** @} */
/** @} */ /** @} */

5
doc/sys.txt
View File

@ -1,5 +0,0 @@
/**
\defgroup sys \os system
@{
*/
/** @} */

7
doc/tutorials.txt
View File

@ -1,7 +0,0 @@
/**
* \defgroup tutorials Tutorials
* @{
This module contains all \os related tutorials.
*/
/** @} */

2
os/lib/crc16.h
View File

@ -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 * The Cyclic Redundancy Check 16 is a hash function that produces a
* checksum that is used to detect errors in transmissions. The CRC16 * checksum that is used to detect errors in transmissions. The CRC16

2
os/lib/heapmem.h
View File

@ -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 * The heapmem module is a dynamic heap memory allocator similar to
* malloc() in standard C. The heap memory is managed in a block of * malloc() in standard C. The heap memory is managed in a block of

4
os/lib/list.h
View File

@ -39,7 +39,7 @@
* *
*/ */
/** \addtogroup lib /** \addtogroup data
@{ */ @{ */
/** /**
* \defgroup list Linked list library * \defgroup list Linked list library
@ -79,7 +79,7 @@
* *
* The list variable is declared as static to make it easy to use in a * 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 * single C module without unnecessarily exporting the name to other
* modules. * modules.
* *
* \param name The name of the list. * \param name The name of the list.
*/ */

2
os/lib/memb.h
View File

@ -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 * The memory block allocation routines provide a simple yet powerful
* set of functions for managing a set of memory blocks of fixed * set of functions for managing a set of memory blocks of fixed

2
os/lib/ringbuf.h
View File

@ -37,7 +37,7 @@
* Adam Dunkels <adam@sics.se> * Adam Dunkels <adam@sics.se>
*/ */
/** \addtogroup lib /** \addtogroup data
* @{ */ * @{ */
/** /**

2
os/net/ipv6/multicast/roll-tm.h
View File

@ -30,7 +30,7 @@
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/smrf.h
View File

@ -30,7 +30,7 @@
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/uip-mcast6-engines.h
View File

@ -30,7 +30,7 @@
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/uip-mcast6-route.c
View File

@ -29,7 +29,7 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/uip-mcast6-route.h
View File

@ -29,7 +29,7 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/uip-mcast6-stats.c
View File

@ -28,7 +28,7 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/multicast/uip-mcast6-stats.h
View File

@ -28,7 +28,7 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup uip6-multicast * \addtogroup uip-multicast
* @{ * @{
*/ */
/** /**

4
os/net/ipv6/multicast/uip-mcast6.h
View File

@ -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: * We currently support 2 engines:
* - 'Stateless Multicast RPL Forwarding' (SMRF) * - 'Stateless Multicast RPL Forwarding' (SMRF)

1
os/net/ipv6/sicslowpan.c
View File

@ -45,6 +45,7 @@
/** /**
* \addtogroup sicslowpan * \addtogroup sicslowpan
* \ingroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-ds6-nbr.c
View File

@ -30,7 +30,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-ds6-nbr.h
View File

@ -30,7 +30,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-ds6-route.c
View File

@ -30,7 +30,7 @@
* *
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-ds6-route.h
View File

@ -30,7 +30,7 @@
* *
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */
/** /**

2
os/net/ipv6/uip-ds6.c
View File

@ -29,7 +29,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-ds6.h
View File

@ -1,5 +1,5 @@
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-icmp6.c
View File

@ -31,7 +31,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-icmp6.h
View File

@ -31,7 +31,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-nameserver.c
View File

@ -1,5 +1,5 @@
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-nameserver.h
View File

@ -1,5 +1,5 @@
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-nd6.c
View File

@ -57,7 +57,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip-nd6.h
View File

@ -31,7 +31,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

2
os/net/ipv6/uip6.c
View File

@ -32,7 +32,7 @@
*/ */
/** /**
* \addtogroup uip6 * \addtogroup uip
* @{ * @{
*/ */

4
os/net/linkaddr.h
View File

@ -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. * The linkaddr module handles link-layer addresses.

2
os/net/mac/framer/frame802154.h
View File

@ -44,7 +44,7 @@
*/ */
/** /**
* \addtogroup net * \addtogroup link-layer
* @{ * @{
*/ */

23
os/net/mac/llsec802154.h
View File

@ -30,6 +30,15 @@
* *
*/ */
/**
* \addtogroup link-layer
* \defgroup llsec802154 Link-Layer security common functionality
*
* Macros related to 802.15.4 link-layer security.
*
* @{
*/
/** /**
* \file * \file
* Common functionality of 802.15.4-compliant llsec_drivers. * Common functionality of 802.15.4-compliant llsec_drivers.
@ -37,19 +46,6 @@
* Konrad Krentz <konrad.krentz@gmail.com> * Konrad Krentz <konrad.krentz@gmail.com>
*/ */
/**
* \addtogroup llsec
* @{
*/
/**
* \defgroup llsec802154 Link Layer Security Common Functionality
*
* Macros related to 802.15.4 link-layer security.
*
* @{
*/
#ifndef LLSEC802154_H_ #ifndef LLSEC802154_H_
#define LLSEC802154_H_ #define LLSEC802154_H_
@ -87,4 +83,3 @@
#endif /* LLSEC802154_H_ */ #endif /* LLSEC802154_H_ */
/** @} */ /** @} */
/** @} */

2
os/net/mac/tsch/sixtop/sixtop.h
View File

@ -28,7 +28,7 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup net * \addtogroup link-layer
* @{ * @{
*/ */
/** /**

6
os/net/mac/tsch/tsch-adaptive-timesync.c
View File

@ -38,6 +38,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#include "net/mac/tsch/tsch.h" #include "net/mac/tsch/tsch.h"
#include "net/mac/tsch/tsch-conf.h" #include "net/mac/tsch/tsch-conf.h"
#include "net/mac/tsch/tsch-adaptive-timesync.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 */ #endif /* TSCH_ADAPTIVE_TIMESYNC */
/** @} */

6
os/net/mac/tsch/tsch-adaptive-timesync.h
View File

@ -30,6 +30,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_ADAPTIVE_TIMESYNC_H__ #ifndef __TSCH_ADAPTIVE_TIMESYNC_H__
#define __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); long int tsch_adaptive_timesync_get_drift_ppm(void);
#endif /* __TSCH_ADAPTIVE_TIMESYNC_H__ */ #endif /* __TSCH_ADAPTIVE_TIMESYNC_H__ */
/** @} */

6
os/net/mac/tsch/tsch-asn.h
View File

@ -38,6 +38,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_ASN_H__ #ifndef __TSCH_ASN_H__
#define __TSCH_ASN_H__ #define __TSCH_ASN_H__
@ -95,3 +100,4 @@ struct tsch_asn_divisor_t {
% (div).val % (div).val
#endif /* __TSCH_ASN_H__ */ #endif /* __TSCH_ASN_H__ */
/** @} */

6
os/net/mac/tsch/tsch-conf.h
View File

@ -37,6 +37,11 @@
* Simon Duquennoy <simonduq@sics.se> * Simon Duquennoy <simonduq@sics.se>
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_CONF_H__ #ifndef __TSCH_CONF_H__
#define __TSCH_CONF_H__ #define __TSCH_CONF_H__
@ -199,3 +204,4 @@
#endif #endif
#endif /* __TSCH_CONF_H__ */ #endif /* __TSCH_CONF_H__ */
/** @} */

6
os/net/mac/tsch/tsch-log.c
View File

@ -40,6 +40,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#include "contiki.h" #include "contiki.h"
#include <stdio.h> #include <stdio.h>
#include "net/mac/tsch/tsch.h" #include "net/mac/tsch/tsch.h"
@ -172,3 +177,4 @@ tsch_log_stop(void)
} }
#endif /* TSCH_LOG_PER_SLOT */ #endif /* TSCH_LOG_PER_SLOT */
/** @} */

6
os/net/mac/tsch/tsch-log.h
View File

@ -30,6 +30,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_LOG_H__ #ifndef __TSCH_LOG_H__
#define __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_PER_SLOT == 0) */
#endif /* __TSCH_LOG_H__ */ #endif /* __TSCH_LOG_H__ */
/** @} */

6
os/net/mac/tsch/tsch-packet.c
View File

@ -38,6 +38,11 @@
* Beshr Al Nahas <beshr@sics.se> * Beshr Al Nahas <beshr@sics.se>
*/ */
/**
* \addtogroup tsch
* @{
*/
#include "contiki.h" #include "contiki.h"
#include "net/packetbuf.h" #include "net/packetbuf.h"
#include "net/mac/tsch/tsch.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; return curr_len;
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @} */

6
os/net/mac/tsch/tsch-packet.h
View File

@ -30,6 +30,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_PACKET_H__ #ifndef __TSCH_PACKET_H__
#define __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); uint8_t *hdrlen, int frame_without_mic);
#endif /* __TSCH_PACKET_H__ */ #endif /* __TSCH_PACKET_H__ */
/** @} */

6
os/net/mac/tsch/tsch-private.h
View File

@ -39,6 +39,11 @@
* Beshr Al Nahas <beshr@sics.se> * Beshr Al Nahas <beshr@sics.se>
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_PRIVATE_H__ #ifndef __TSCH_PRIVATE_H__
#define __TSCH_PRIVATE_H__ #define __TSCH_PRIVATE_H__
@ -130,3 +135,4 @@ void tsch_disassociate(void);
while(!(cond) && RTIMER_CLOCK_LT(RTIMER_NOW(), (t0) + (offset))) ; while(!(cond) && RTIMER_CLOCK_LT(RTIMER_NOW(), (t0) + (offset))) ;
#endif /* CONTIKI_TARGET_COOJA || CONTIKI_TARGET_COOJA_IP64 */ #endif /* CONTIKI_TARGET_COOJA || CONTIKI_TARGET_COOJA_IP64 */
#endif /* __TSCH_PRIVATE_H__ */ #endif /* __TSCH_PRIVATE_H__ */
/** @} */

6
os/net/mac/tsch/tsch-queue.c
View File

@ -42,6 +42,11 @@
* Domenico De Guglielmo <d.deguglielmo@iet.unipi.it > * Domenico De Guglielmo <d.deguglielmo@iet.unipi.it >
*/ */
/**
* \addtogroup tsch
* @{
*/
#include "contiki.h" #include "contiki.h"
#include "lib/list.h" #include "lib/list.h"
#include "lib/memb.h" #include "lib/memb.h"
@ -524,3 +529,4 @@ tsch_queue_init(void)
n_broadcast = tsch_queue_add_nbr(&tsch_broadcast_address); n_broadcast = tsch_queue_add_nbr(&tsch_broadcast_address);
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @} */

6
os/net/mac/tsch/tsch-queue.h
View File

@ -30,6 +30,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_QUEUE_H__ #ifndef __TSCH_QUEUE_H__
#define __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); void tsch_queue_init(void);
#endif /* __TSCH_QUEUE_H__ */ #endif /* __TSCH_QUEUE_H__ */
/** @} */

6
os/net/mac/tsch/tsch-rpl.c
View File

@ -35,6 +35,11 @@
* \author Simon Duquennoy <simonduq@sics.se> * \author Simon Duquennoy <simonduq@sics.se>
*/ */
/**
* \addtogroup tsch
* @{
*/
#if UIP_CONF_IPV6_RPL #if UIP_CONF_IPV6_RPL
#include "contiki.h" #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 */ #endif /* UIP_CONF_IPV6_RPL */
/** @} */

5
os/net/mac/tsch/tsch-rpl.h
View File

@ -28,6 +28,10 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_RPL_H__ #ifndef __TSCH_RPL_H__
#define __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); void tsch_rpl_callback_parent_switch(rpl_parent_t *old, rpl_parent_t *new);
#endif /* __TSCH_RPL_H__ */ #endif /* __TSCH_RPL_H__ */
/** @} */

6
os/net/mac/tsch/tsch-schedule.c
View File

@ -38,6 +38,11 @@
* Beshr Al Nahas <beshr@sics.se> * Beshr Al Nahas <beshr@sics.se>
*/ */
/**
* \addtogroup tsch
* @{
*/
#include "contiki.h" #include "contiki.h"
#include "dev/leds.h" #include "dev/leds.h"
#include "lib/memb.h" #include "lib/memb.h"
@ -468,3 +473,4 @@ tsch_schedule_print(void)
} }
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** @} */

6
os/net/mac/tsch/tsch-schedule.h
View File

@ -30,6 +30,11 @@
* *
*/ */
/**
* \addtogroup tsch
* @{
*/
#ifndef __TSCH_SCHEDULE_H__ #ifndef __TSCH_SCHEDULE_H__
#define __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); struct tsch_slotframe *tsch_schedule_slotframe_next(struct tsch_slotframe *sf);
#endif /* __TSCH_SCHEDULE_H__ */ #endif /* __TSCH_SCHEDULE_H__ */
/** @} */

Some files were not shown because too many files have changed in this diff Show More