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

components/dfs/dfs_v1/src/dfs.c

@@ -39,10 +39,9 @@ static int  fd_alloc(struct dfs_fdtable *fdt, int startfd);
 
 /**
  * @addtogroup DFS
+ * @{
  */
 
-/*@{*/
-
 /**
  * this function will initialize device file system.
  */
@@ -967,5 +966,5 @@ MSH_CMD_EXPORT(lsof, list open files);
 #endif /* RT_USING_SMART */
 
 #endif
-/*@}*/
+/**@}*/
 

components/dfs/dfs_v1/src/dfs_file.c

@@ -89,10 +89,9 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
 
 /**
  * @addtogroup FileApi
+ * @{
  */
 
-/*@{*/
-
 /**
  * This function will return whether this file has been opend.
  *
@@ -1091,5 +1090,5 @@ FINSH_FUNCTION_EXPORT(copy, copy file or dir)
 #endif /* DFS_USING_POSIX */
 
 #endif /* RT_USING_FINSH */
-/* @} */
+/**@}*/
 

components/dfs/dfs_v1/src/dfs_fs.c

@@ -18,8 +18,8 @@
 
 /**
  * @addtogroup FsApi
+ * @{
  */
-/*@{*/
 
 /**
  * this function will register a file system instance to device file system.
@@ -654,4 +654,4 @@ int df(const char *path)
 FINSH_FUNCTION_EXPORT(df, get disk free);
 #endif
 
-/* @} */
+/**@}*/

components/dfs/dfs_v1/src/dfs_posix.c

@@ -20,10 +20,9 @@
 
 /**
  * @addtogroup FsPosixApi
+ * @{
  */
 
-/*@{*/
-
 /**
  * this function is a POSIX compliant version, which will open a file and
  * return a file descriptor according specified flags.
@@ -260,8 +259,8 @@ RTM_EXPORT(lseek);
  * this function is a POSIX compliant version, which will rename old file name
  * to new file name.
  *
- * @param old the old file name.
- * @param new the new file name.
+ * @param old_file the old file name.
+ * @param new_file the new file name.
  *
  * @return 0 on successful, -1 on failed.
  *
@@ -392,7 +391,7 @@ RTM_EXPORT(fsync);
  *
  * @param fildes the file description
  * @param cmd the specified command
- * @param data represents the additional information that is needed by this
+ * @param ... represents the additional information that is needed by this
  * specific device to perform the requested function.
  *
  * @return 0 on successful completion. Otherwise, -1 shall be returned and errno
@@ -434,7 +433,7 @@ RTM_EXPORT(fcntl);
  *
  * @param fildes the file description
  * @param cmd the specified command
- * @param data represents the additional information that is needed by this
+ * @param ... represents the additional information that is needed by this
  * specific device to perform the requested function.
  *
  * @return 0 on successful completion. Otherwise, -1 shall be returned and errno
@@ -921,8 +920,6 @@ int access(const char *path, int amode)
  * working directory.
  *
  * @param buf the current directory.
- *
- * @return null.
  */
 void setcwd(char *buf)
 {
@@ -979,4 +976,4 @@ char *getcwd(char *buf, size_t size)
 }
 RTM_EXPORT(getcwd);
 
-/* @} */
+/**@}*/

components/dfs/dfs_v2/src/dfs.c

@@ -39,10 +39,9 @@ static int  fd_alloc(struct dfs_fdtable *fdt, int startfd);
 
 /**
  * @addtogroup DFS
+ * @{
  */
 
-/*@{*/
-
 /**
  * this function will initialize device file system.
  */
@@ -967,5 +966,5 @@ MSH_CMD_EXPORT(lsof, list open files);
 #endif /* RT_USING_SMART */
 
 #endif
-/*@}*/
+/**@}*/
 

components/dfs/dfs_v2/src/dfs_file.c

@@ -89,10 +89,9 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
 
 /**
  * @addtogroup FileApi
+ * @{
  */
 
-/*@{*/
-
 /**
  * This function will return whether this file has been opend.
  *
@@ -1091,5 +1090,5 @@ FINSH_FUNCTION_EXPORT(copy, copy file or dir)
 #endif /* DFS_USING_POSIX */
 
 #endif /* RT_USING_FINSH */
-/* @} */
+/**@}*/
 

components/dfs/dfs_v2/src/dfs_fs.c

@@ -18,8 +18,8 @@
 
 /**
  * @addtogroup FsApi
+ * @{
  */
-/*@{*/
 
 /**
  * this function will register a file system instance to device file system.
@@ -654,4 +654,4 @@ int df(const char *path)
 FINSH_FUNCTION_EXPORT(df, get disk free);
 #endif
 
-/* @} */
+/**@}*/

components/dfs/dfs_v2/src/dfs_posix.c

@@ -20,10 +20,9 @@
 
 /**
  * @addtogroup FsPosixApi
+ * @{
  */
 
-/*@{*/
-
 /**
  * this function is a POSIX compliant version, which will open a file and
  * return a file descriptor according specified flags.
@@ -260,8 +259,8 @@ RTM_EXPORT(lseek);
  * this function is a POSIX compliant version, which will rename old file name
  * to new file name.
  *
- * @param old the old file name.
- * @param new the new file name.
+ * @param old_file the old file name.
+ * @param new_file the new file name.
  *
  * @return 0 on successful, -1 on failed.
  *
@@ -392,7 +391,7 @@ RTM_EXPORT(fsync);
  *
  * @param fildes the file description
  * @param cmd the specified command
- * @param data represents the additional information that is needed by this
+ * @param ... represents the additional information that is needed by this
  * specific device to perform the requested function.
  *
  * @return 0 on successful completion. Otherwise, -1 shall be returned and errno
@@ -434,7 +433,7 @@ RTM_EXPORT(fcntl);
  *
  * @param fildes the file description
  * @param cmd the specified command
- * @param data represents the additional information that is needed by this
+ * @param ... represents the additional information that is needed by this
  * specific device to perform the requested function.
  *
  * @return 0 on successful completion. Otherwise, -1 shall be returned and errno
@@ -921,8 +920,6 @@ int access(const char *path, int amode)
  * working directory.
  *
  * @param buf the current directory.
- *
- * @return null.
  */
 void setcwd(char *buf)
 {
@@ -979,4 +976,4 @@ char *getcwd(char *buf, size_t size)
 }
 RTM_EXPORT(getcwd);
 
-/* @} */
+/**@}*/

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

documentation/doxygen/hardware.h

@@ -12,28 +12,30 @@
  * 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);
 
 /**
  * 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);
 
-/*@}*/
+/**@}*/

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
  */
 
-/*@}*/
+/**@}*/

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);