diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-09-20 20:31:20 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-09-20 20:31:20 +0000 |
| commit | 42e2ea515d9c24187d57cffcd2889c4641384165 (patch) | |
| tree | 0390d78ffcb08b1097979724198deffcca638256 /os/kernel/include/chthreads.h | |
| parent | 1c7c4673d2cbd6f4ef0f9198ddc7edbfea56332f (diff) | |
| download | ChibiOS-42e2ea515d9c24187d57cffcd2889c4641384165.tar.gz ChibiOS-42e2ea515d9c24187d57cffcd2889c4641384165.tar.bz2 ChibiOS-42e2ea515d9c24187d57cffcd2889c4641384165.zip | |
Improved documentation of sleep functions.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3375 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel/include/chthreads.h')
| -rw-r--r-- | os/kernel/include/chthreads.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/os/kernel/include/chthreads.h b/os/kernel/include/chthreads.h index d99b2ee3b..582b4e1e1 100644 --- a/os/kernel/include/chthreads.h +++ b/os/kernel/include/chthreads.h @@ -291,7 +291,7 @@ typedef msg_t (*tfunc_t)(void *); * system clock.
* @note The maximum specified value is implementation dependent.
*
- * @param[in] sec time in seconds
+ * @param[in] sec time in seconds, must be different from zero
*
* @api
*/
@@ -304,7 +304,7 @@ typedef msg_t (*tfunc_t)(void *); * system clock.
* @note The maximum specified value is implementation dependent.
*
- * @param[in] msec time in milliseconds
+ * @param[in] msec time in milliseconds, must be different from zero
*
* @api
*/
@@ -317,7 +317,7 @@ typedef msg_t (*tfunc_t)(void *); * system clock.
* @note The maximum specified value is implementation dependent.
*
- * @param[in] usec time in microseconds
+ * @param[in] usec time in microseconds, must be different from zero
*
* @api
*/
|