From 80a8621ec04e3fa9588ad09cbf0f1b6da1429776 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Wed, 11 Mar 2009 09:22:59 +0000
Subject: Documentation improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@830 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 src/chsys.c | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'src/chsys.c')

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) {
 
-- 
cgit v1.2.3