summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbernard <[email protected]>2014-09-11 12:50:41 +0800
committerbernard <[email protected]>2014-09-11 12:50:41 +0800
commitab786679c7040b4bdb7920f6b35b52045e830d8a (patch)
tree52e6940918fd798680bd18a4d44ea093f548e463
parenta8b0fe3f3691f63c002331b844986eaf33eefcee (diff)
[Kernel] comments clean up.
-rw-r--r--src/idle.c14
1 files changed, 4 insertions, 10 deletions
diff --git a/src/idle.c b/src/idle.c
index 7bca6c28cb..ab0c992212 100644
--- a/src/idle.c
+++ b/src/idle.c
@@ -44,16 +44,12 @@ static rt_uint8_t rt_thread_stack[IDLE_THREAD_STACK_SIZE];
extern rt_list_t rt_thread_defunct;
#ifdef RT_USING_HOOK
-/**
- * @addtogroup Hook
- */
-
-/*@{*/
-
static void (*rt_thread_idle_hook)();
/**
- * This function will set a hook function to idle thread loop.
+ * @ingroup Hook
+ * This function sets a hook function to idle thread loop. When the system performs
+ * idle loop, this hook function should be invoked.
*
* @param hook the specified hook function
*
@@ -63,8 +59,6 @@ void rt_thread_idle_sethook(void (*hook)(void))
{
rt_thread_idle_hook = hook;
}
-
-/*@}*/
#endif
/**
@@ -180,7 +174,7 @@ static void rt_thread_idle_entry(void *parameter)
}
/**
- * @ingroup SymstemInit
+ * @ingroup SystemInit
*
* This function will initialize idle thread, then start it.
*