riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5376 from OlegHahm/doxy_fixes

Browse Source 
doc: document THREAD_STACKSIZE correctly and fix PRNG documentation
This commit is contained in:
Andreas "Paul" Pauli 2016-05-18 15:00:10 +02:00
commit c805853c34
2 changed files with 30 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
core/include/thread.h
View File

@ -102,30 +102,48 @@ struct _thread {
#endif #endif
}; };
/** /**
* @def THREAD_STACKSIZE_DEFAULT * @def THREAD_STACKSIZE_DEFAULT
* @brief A reasonable default stack size that will suffice most smaller tasks * @brief A reasonable default stack size that will suffice most smaller tasks
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_STACKSIZE_DEFAULT #ifndef THREAD_STACKSIZE_DEFAULT
#error THREAD_STACKSIZE_DEFAULT must be defined per CPU #error THREAD_STACKSIZE_DEFAULT must be defined per CPU
#endif #endif
#ifdef DOXYGEN
#define THREAD_STACKSIZE_DEFAULT
#endif
/** /**
* @def THREAD_STACKSIZE_IDLE * @def THREAD_STACKSIZE_IDLE
* @brief Size of the idle task's stack in bytes * @brief Size of the idle task's stack in bytes
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_STACKSIZE_IDLE #ifndef THREAD_STACKSIZE_IDLE
#error THREAD_STACKSIZE_IDLE must be defined per CPU #error THREAD_STACKSIZE_IDLE must be defined per CPU
#endif #endif
#ifdef DOXYGEN
#define THREAD_STACKSIZE_IDLE
#endif
/** /**
* @def THREAD_EXTRA_STACKSIZE_PRINTF * @def THREAD_EXTRA_STACKSIZE_PRINTF
* @ingroup conf * @ingroup conf
* @brief Size of the task's printf stack in bytes * @brief Size of the task's printf stack in bytes
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_EXTRA_STACKSIZE_PRINTF #ifndef THREAD_EXTRA_STACKSIZE_PRINTF
#error THREAD_EXTRA_STACKSIZE_PRINTF must be defined per CPU #error THREAD_EXTRA_STACKSIZE_PRINTF must be defined per CPU
#endif #endif
#ifdef DOXYGEN
#define THREAD_EXTRA_STACKSIZE_PRINTF
#endif
/** /**
* @def THREAD_STACKSIZE_MAIN * @def THREAD_STACKSIZE_MAIN
@ -191,7 +209,8 @@ struct _thread {
* *
* Creating a new thread is done in two steps: * Creating a new thread is done in two steps:
* 1. the new thread's stack is initialized depending on the platform * 1. the new thread's stack is initialized depending on the platform
* 2. the new thread is added to the scheduler to be run * 2. the new thread is added to the scheduler and the scheduler is run (if not
* indicated otherwise)
* *
* As RIOT is using a fixed priority scheduling algorithm, threads are * As RIOT is using a fixed priority scheduling algorithm, threads are
* scheduled based on their priority. The priority is fixed for every thread * scheduled based on their priority. The priority is fixed for every thread

12
sys/include/random.h
View File

@ -10,11 +10,17 @@
/** /**
* @defgroup sys_random Random * @defgroup sys_random Random
* @ingroup sys * @ingroup sys
* @brief Random number generator * @brief Pseudo Random Number Generator (PRNG)
* @{ * @{
* *
* @file * @file
* @brief Mersenne Twister - a very fast random number generator * @brief Common interface to the software PRNG
*
* Various implementations of a PRNG are available:
* - Tiny Mersenne Twister (default)
* - Mersenne Twister
* - Simple Park-Miller PRNG
* - Musl C PRNG
*/ */
#ifndef RANDOM_H #ifndef RANDOM_H
@ -31,7 +37,7 @@ extern "C" {
#endif #endif
/** /**
* @brief initializes mt[N] with a seed * @brief initializes PRNG with a seed
* *
* @param s seed for the PRNG * @param s seed for the PRNG
*/ */