[HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen.

将Doxygen输入文件（由Doxyfile中的INPUT定义）中的失效Doxygen分组指令（如/*@*/和/*@}*/）更改为有效的分组指令（如/**@*/和/**@}*/）；（此处只对INPUT中的文件做了修改，bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令，但由于不作为文档的输入文件且这些文件过于庞大老旧，没有对这些文件中的无效指令做修改）
将图片文件统一放入了images目录下；
修改了Doxyfile和部分Doxygen注释，使得Doxyfile能够定位到新的代码路径且不受重复实现的影响；
解决了一些注释中的参数名不匹配、参数多余/缺失等问题。

12 files changed, 108 insertions, 27 deletions

diff --git a/documentation/doxygen/Doxyfile b/documentation/doxygen/Doxyfile
index 582ca8cd8f..03f04279fa 100644
--- a/documentation/doxygen/Doxyfile
+++ b/documentation/doxygen/Doxyfile
@@ -60,7 +60,7 @@ PROJECT_BRIEF          = "An open source embedded real-time operating system"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ./rtthread_logo.png
+PROJECT_LOGO           = ./images/rtthread_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -128,7 +128,7 @@ BRIEF_MEMBER_DESC      = NO
 # brief descriptions will be completely suppressed.
 # The default value is: YES.
 
-REPEAT_BRIEF           = NO
+REPEAT_BRIEF           = YES
 
 # This tag implements a quasi-intelligent brief description abbreviator that is
 # used to form the text in various listings. Each string in this list, if found
@@ -156,7 +156,7 @@ ABBREVIATE_BRIEF       = "The $name class" \
 # description.
 # The default value is: NO.
 
-ALWAYS_DETAILED_SEC    = NO
+ALWAYS_DETAILED_SEC    = YES
 
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
 # inherited members of a class in the documentation of that class as if those
@@ -910,8 +910,8 @@ INPUT                  = ../../src \
                          ../../include \
                          . \
                          ../../components/finsh \
-                         ../../components/dfs/src \
-                         ../../components/dfs/include
+                         ../../components/dfs/dfs_v2/src \
+                         ../../components/dfs/dfs_v2/include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1012,7 +1012,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = ../doxygen
+IMAGE_PATH             = ./images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/documentation/doxygen/hardware.h b/documentation/doxygen/hardware.h
index dd50f3abe8..bc05274998 100644
--- a/documentation/doxygen/hardware.h
+++ b/documentation/doxygen/hardware.h
@@ -12,21 +12,21 @@
  * in board, the pinmux setting etc. In RT-Thread RTOS, the bsp is placed under bsp
  * directory.
  *
- * Chip Support Package (CSP) is a software set that contains chip specific software.
+ * Chip Support Package(CSP) is a software set that contains chip specific software.
  * A CSP usually includes operating system porting and peripheral device drivers inside
  * chip. In RT-Thread RTOS, the csp is placed under libcpu directory.
  */
 
 /**
  * @addtogroup bsp
+ * @{
  */
-/*@{*/
 
 /**
  * This function will return current system interrupt status and disable system
  * interrupt.
  *
- * @return the current system interrupt status
+ * @return the current system interrupt status.
  */
 rt_base_t rt_hw_interrupt_disable(void);
 
@@ -34,6 +34,8 @@ rt_base_t rt_hw_interrupt_disable(void);
  * This function will set the specified interrupt status, which shall saved by
  * rt_hw_intterrupt_disable function. If the saved interrupt status is interrupt
  * opened, this function will open system interrupt status.
+ *
+ * @param level the interrupt status to be set.
  */
 void rt_hw_interrupt_enable(rt_base_t level);
 
@@ -70,7 +72,7 @@ void rt_hw_interrupt_umask(int vector);
  * @note not all of platform provide this function.
  */
 void rt_hw_interrupt_install(int vector, rt_isr_handler_t new_handler,
-		rt_isr_handler_t *old_handler);
+                            rt_isr_handler_t *old_handler);
 
 /**
  * This function will reset whole platform.
@@ -82,4 +84,4 @@ void rt_hw_cpu_reset(void);
  */
 void rt_hw_cpu_shutdown(void);
 
-/*@}*/
+/**@}*/
diff --git a/documentation/doxygen/images/.gitkeep b/documentation/doxygen/images/.gitkeep
deleted file mode 100644
index e69de29bb2..0000000000
--- a/documentation/doxygen/images/.gitkeep
+++ /dev/null
diff --git a/documentation/doxygen/Kernel_Object.png b/documentation/doxygen/images/Kernel_Object.png
index 153d9e59dd..153d9e59dd 100644
--- a/documentation/doxygen/Kernel_Object.png
+++ b/documentation/doxygen/images/Kernel_Object.png
diff --git a/documentation/doxygen/System_Arch.png b/documentation/doxygen/images/System_Arch.png
index bdf074d4e9..bdf074d4e9 100644
--- a/documentation/doxygen/System_Arch.png
+++ b/documentation/doxygen/images/System_Arch.png
diff --git a/documentation/doxygen/Thread_Scheduler.png b/documentation/doxygen/images/Thread_Scheduler.png
index 1854798eeb..1854798eeb 100644
--- a/documentation/doxygen/Thread_Scheduler.png
+++ b/documentation/doxygen/images/Thread_Scheduler.png
diff --git a/documentation/doxygen/dfs.png b/documentation/doxygen/images/dfs.png
index 72466ac28b..72466ac28b 100644
--- a/documentation/doxygen/dfs.png
+++ b/documentation/doxygen/images/dfs.png
diff --git a/documentation/doxygen/finsh.png b/documentation/doxygen/images/finsh.png
index 2c75807383..2c75807383 100644
--- a/documentation/doxygen/finsh.png
+++ b/documentation/doxygen/images/finsh.png
diff --git a/documentation/doxygen/rtthread_logo.png b/documentation/doxygen/images/rtthread_logo.png
index 334260f5ab..334260f5ab 100644
--- a/documentation/doxygen/rtthread_logo.png
+++ b/documentation/doxygen/images/rtthread_logo.png
diff --git a/documentation/doxygen/kernel.h b/documentation/doxygen/kernel.h
index 527ce835f0..ad6471db36 100644
--- a/documentation/doxygen/kernel.h
+++ b/documentation/doxygen/kernel.h
@@ -16,8 +16,8 @@
 
 /**
  * @addtogroup Kernel
+ * @{
  */
-/*@{*/
 
 /**
  * @defgroup Thread Thread Management
@@ -41,7 +41,7 @@
 
 /**
  * @defgroup Clock Clock and Timer Management
- *  * @brief clock and system timer management
+ * @brief clock and system timer management
  *
  * RT-Thread uses clock tick to implement shared time-slice scheduling.
  *
@@ -157,4 +157,4 @@
  * bad things happen, the current thread's errno will be set. see @ref _rt_errno
  */
 
-/*@}*/
+/**@}*/
diff --git a/documentation/doxygen/systeminit.h b/documentation/doxygen/systeminit.h
index c45eda4079..c320529303 100644
--- a/documentation/doxygen/systeminit.h
+++ b/documentation/doxygen/systeminit.h
@@ -7,7 +7,7 @@
  *
  * @brief System initialization procedure.
  *
- * When RT-Thread operating system starts up, the basic operating system facility 
+ * When RT-Thread operating system starts up, the basic operating system facility
  * initialization routines must be invoked.
  *
  * The suggested initialization sequence is:
@@ -55,19 +55,9 @@
  * has not started. User can allocate memory, create thread, semaphore etc. However,
  * user shall not suspend 'current' thread.
  */
-void rt_application_init()
-{
-}
+void rt_application_init();
 
 /**
  * @ingroup SystemInit
- *
- * This function will initialize system heap memory.
- *
- * @param begin_addr the beginning address of system heap memory.
- * @param end_addr the end address of system heap memory.
- *
  */
-void rt_system_heap_init(void* begin_addr, void* end_addr)
-{
-}
+void rt_system_heap_init(void* begin_addr, void* end_addr);
diff --git a/documentation/doxygen/thread.h b/documentation/doxygen/thread.h
new file mode 100644
index 0000000000..76ca383717
--- /dev/null
+++ b/documentation/doxygen/thread.h
@@ -0,0 +1,89 @@
+/*
+ * This file is only used for doxygen document generation.
+ */
+
+/**
+ * @addtogroup Thread
+ * @{
+ */
+
+/**
+ * @brief This function will handle IPI interrupt and do a scheduling in system.
+ *
+ * @param vector is the number of IPI interrupt for system scheduling.
+ *
+ * @param param is not used, and can be set to RT_NULL.
+ *
+ * @note this function should be invoke or register as ISR in BSP.
+ *
+ * @note this function is only implemented in scheduler_mp.c.
+ */
+void rt_scheduler_ipi_handler(int vector, void *param);
+
+/**
+ * @brief This function will perform one scheduling. It will select one thread
+ *        with the highest priority level in global ready queue or local ready queue,
+ *        then switch to it.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+void rt_schedule(void);
+
+/**
+ * @brief This function checks whether a scheduling is needed after an IRQ context switching. If yes,
+ *        it will select one thread with the highest priority level, and then switch
+ *        to it.
+ *
+ * @param context is the context to be switched to.
+ *
+ * @note this function is only implemented in scheduler_mp.c.
+ */
+void rt_scheduler_do_irq_switch(void *context);
+
+/**
+ * @brief This function will insert a thread to the system ready queue. The state of
+ *        thread will be set as READY and the thread will be removed from suspend queue.
+ *
+ * @param thread is the thread to be inserted.
+ *
+ * @note  Please do not invoke this function in user application.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+void rt_schedule_insert_thread(struct rt_thread *thread);
+
+/**
+ * @brief This function will remove a thread from system ready queue.
+ *
+ * @param thread is the thread to be removed.
+ *
+ * @note  Please do not invoke this function in user application.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+void rt_schedule_remove_thread(struct rt_thread *thread);
+
+/**
+ * @brief This function will lock the thread scheduler.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+void rt_enter_critical(void);
+
+/**
+ * @brief This function will unlock the thread scheduler.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+void rt_exit_critical(void);
+
+/**
+ * @brief Get the scheduler lock level.
+ *
+ * @return the level of the scheduler lock. 0 means unlocked.
+ *
+ * @note this function is implemented in both scheduler_up.c and scheduler_mp.c.
+ */
+rt_uint16_t rt_critical_level(void);
+
+/**@}*/