aboutsummaryrefslogtreecommitdiffstats
path: root/src/chsys.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-03-11 09:22:59 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-03-11 09:22:59 +0000
commit80a8621ec04e3fa9588ad09cbf0f1b6da1429776 (patch)
tree4e4cc8a942480df8e57312051d6484c155e17502 /src/chsys.c
parent7dbc6a75678e6e06ec99786eb945d043b64e9721 (diff)
downloadChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.tar.gz
ChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.tar.bz2
ChibiOS-80a8621ec04e3fa9588ad09cbf0f1b6da1429776.zip
Documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@830 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'src/chsys.c')
-rw-r--r--src/chsys.c20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/chsys.c b/src/chsys.c
index 666d0cfef..cedd3d28b 100644
--- a/src/chsys.c
+++ b/src/chsys.c
@@ -31,13 +31,12 @@ static WORKING_AREA(idle_thread_wa, IDLE_THREAD_STACK_SIZE);
/**
* @brief This function implements the idle thread infinite loop.
* @details The function puts the processor in the lowest power mode capable
- * to serve interrupts.<br>
- * The priority is internally set to the minimum system value so that this
- * thread is executed only if there are no other ready threads in the system.
+ * to serve interrupts.<br>
+ * The priority is internally set to the minimum system value so
+ * that this thread is executed only if there are no other ready
+ * threads in the system.
*
- * @param p the thread parameter, unused in this scenario
- * @note Implementation should declare this function as a weak symbol in order
- * to allow applications to re-implement it.
+ * @param[in] p the thread parameter, unused in this scenario
*/
static void idle_thread(void *p) {
@@ -50,7 +49,7 @@ static void idle_thread(void *p) {
/**
* @brief ChibiOS/RT initialization.
* @details After executing this function the current instructions stream
- * becomes the main thread.
+ * becomes the main thread.
*
* @note Interrupts should be still disabled when @p chSysInit() is invoked
* and are internally enabled.
@@ -88,10 +87,11 @@ void chSysInit(void) {
/**
* @brief Handles time ticks for round robin preemption and timer increments.
* @details Decrements the remaining time quantum of the running thread
- * and preempts it when the quantum is used up. Increments system time and
- * manages the timers.
+ * and preempts it when the quantum is used up. Increments system
+ * time and manages the timers.
+ *
* @note The frequency of the timer determines the system tick granularity and,
- * together with the @p CH_TIME_QUANTUM macro, the round robin interval.
+ * together with the @p CH_TIME_QUANTUM macro, the round robin interval.
*/
void chSysTimerHandlerI(void) {