Kernel documentation fixes and improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3251 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 5 insertions, 1 deletions

diff --git a/os/kernel/include/chregistry.h b/os/kernel/include/chregistry.h
index 0967f699e..8f7ebd4b9 100644
--- a/os/kernel/include/chregistry.h
+++ b/os/kernel/include/chregistry.h
@@ -31,6 +31,10 @@
 

 #if CH_USE_REGISTRY || defined(__DOXYGEN__)

 /**

+ * @name    Macro Functions

+ * @{

+ */

+/**

  * @brief   Sets the current thread name.

  * @pre     This function only stores the pointer to the name if the option

  *          @p CH_USE_REGISTRY is enabled else no action is performed.

@@ -52,13 +56,13 @@
  * @retval NULL         if the thread name has not been set.

  */

 #define chRegGetThreadName(tp) ((tp)->p_name)

+/** @} */

 #else /* !CH_USE_REGISTRY */

 #define chRegSetThreadName(p)

 #define chRegGetThreadName(tp) NULL

 #endif /* !CH_USE_REGISTRY */

 

 #if CH_USE_REGISTRY || defined(__DOXYGEN__)

-

 /**

  * @brief   Removes a thread from the registry list.

  * @note    This macro is not meant for use in application code.