Documentation improvements, renamed some event APIs.

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

1 files changed, 6 insertions, 7 deletions

diff --git a/os/kernel/src/chregistry.c b/os/kernel/src/chregistry.c
index c561d8ca6..216758c85 100644
--- a/os/kernel/src/chregistry.c
+++ b/os/kernel/src/chregistry.c
@@ -40,25 +40,24 @@
  *          Another possible use is for centralized threads memory management,

  *          terminating threads can pulse an event source and an event handler

  *          can perform a scansion of the registry in order to recover the

- *          memory.<br>

- *          In order to use the threads registry the @p CH_USE_REGISTRY option

+ *          memory.

+ * @pre     In order to use the threads registry the @p CH_USE_REGISTRY option

  *          must be enabled in @p chconf.h.

  * @{

  */

 #include "ch.h"

 

-#if CH_USE_REGISTRY

+#if CH_USE_REGISTRY || defined(__DOXYGEN__)

 

 /**

  * @brief   Returns the first thread in the system.

  * @details Returns the most ancient thread in the system, usually this is

- *          the main thread unless it terminated.

- * @note    A reference is added to the returned thread in order to make sure

- *          it status is not lost.

+ *          the main thread unless it terminated. A reference is added to the

+ *          returned thread in order to make sure its status is not lost.

  * @note    This function cannot return @p NULL because there is always at

  *          least one thread in the system.

  *

- * @return              A reference to the first thread.

+ * @return              A reference to the most ancient thread.

  */

 Thread *chRegFirstThread(void) {

   Thread *tp;