mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
doc: Improve C++ documentation
Move C++ modules in a new menu tree and improve the description.
This commit is contained in:
parent
e3f6212708
commit
a0930a8ec0
7
doc.txt
7
doc.txt
@ -15,6 +15,13 @@
|
|||||||
* `CFLAGS += -DSOME_CONFIGURATION_PARAM=SOME_VALUE`)
|
* `CFLAGS += -DSOME_CONFIGURATION_PARAM=SOME_VALUE`)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup cpp C++
|
||||||
|
* @brief C++ Support in RIOT-OS
|
||||||
|
*
|
||||||
|
* This group contains all C++ related modules for easier reference.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup utils Utilities
|
* @defgroup utils Utilities
|
||||||
* @brief Utilities and helper functionality
|
* @brief Utilities and helper functionality
|
||||||
|
@ -40,11 +40,13 @@ RIOT Modules in C++ {#cpp-in-riot}
|
|||||||
RIOT modules should be written in C, so that boards/platforms without or partial
|
RIOT modules should be written in C, so that boards/platforms without or partial
|
||||||
C++ support can still use these modules. However, external modules, packages,
|
C++ support can still use these modules. However, external modules, packages,
|
||||||
and modules that require C++ support anyway (e.g. the Arduino compatibility
|
and modules that require C++ support anyway (e.g. the Arduino compatibility
|
||||||
features) can be written in C++. These modules/packages have to depend on the
|
features) can be written in C++. Also, some modules might be designed as
|
||||||
|
compatibility layer for C++ or provide convenient access to RIOT-OS' features
|
||||||
|
using C++ APIs. These modules/packages have to depend on the
|
||||||
`cpp` feature (`FEATURES_REQUIRED += cpp`) and possibly the `libstdcpp`
|
`cpp` feature (`FEATURES_REQUIRED += cpp`) and possibly the `libstdcpp`
|
||||||
feature using their `Makefile.dep`.
|
feature using their `Makefile.dep`.
|
||||||
|
|
||||||
See Also {#see-also}
|
See Also {#see-also}
|
||||||
========
|
========
|
||||||
|
|
||||||
@ref sys_c11_atomics_cpp_compat, @ref cpp11-compat
|
Reference @ref cpp for a list of C++ modules.
|
||||||
|
@ -9,5 +9,5 @@
|
|||||||
/**
|
/**
|
||||||
* @defgroup cpp11-compat C++11 wrapper for RIOT
|
* @defgroup cpp11-compat C++11 wrapper for RIOT
|
||||||
* @brief drop in replacement to enable C++11-like thread, mutex and condition_variable
|
* @brief drop in replacement to enable C++11-like thread, mutex and condition_variable
|
||||||
* @ingroup sys
|
* @ingroup cpp
|
||||||
*/
|
*/
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
/**
|
/**
|
||||||
@defgroup sys_cxx_ctor_guards C++ constructor guards for static instances
|
@defgroup sys_cxx_ctor_guards C++ constructor guards for static instances
|
||||||
@ingroup sys
|
@ingroup cpp
|
||||||
@brief C++ constructor guards for thread-safe initialization of static
|
@brief C++ constructor guards for thread-safe initialization of static
|
||||||
instances
|
instances
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup sys_c11_atomics_cpp_compat C++ compatibility with C11 atomics
|
* @defgroup sys_c11_atomics_cpp_compat C++ compatibility with C11 atomics
|
||||||
* @ingroup sys
|
* @ingroup cpp
|
||||||
* @brief C++ compatibility of default C11 atomics types
|
* @brief C++ compatibility of default C11 atomics types
|
||||||
*
|
*
|
||||||
* This module provides opaque `typedef`s for each standard C11 atomic type with
|
* This module provides opaque `typedef`s for each standard C11 atomic type with
|
||||||
|
Loading…
Reference in New Issue
Block a user