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, 22 insertions, 4 deletions

diff --git a/os/kernel/include/chioch.h b/os/kernel/include/chioch.h
index 02757c7e9..3361926e3 100644
--- a/os/kernel/include/chioch.h
+++ b/os/kernel/include/chioch.h
@@ -67,6 +67,8 @@
   _base_sequential_stream_data

 

 /**

+ * @extends BaseSequentialStreamVMT

+ *

  * @brief   @p BaseChannel virtual methods table.

  */

 struct BaseChannelVMT {                                                     \

@@ -87,6 +89,10 @@ typedef struct {
 } BaseChannel;

 

 /**

+ * @name    Macro Functions (BaseChannel)

+ * @{

+ */

+/**

  * @brief   Channel output check.

  * @details This function verifies if a subsequent put/write operation would

  *          block.

@@ -227,9 +233,13 @@ typedef struct {
  */

 #define chIOReadTimeout(ip, bp, n, time)                                    \

   ((ip)->vmt->readt(ip, bp, n, time))

+/** @} */

 

-#if CH_USE_EVENTS

-

+#if CH_USE_EVENTS || defined(__DOXYGEN__)

+/**

+ * @name    I/O status flags

+ * @{

+ */

 /** @brief No pending conditions.*/

 #define IO_NO_ERROR             0

 /** @brief Connection happened.*/

@@ -242,6 +252,7 @@ typedef struct {
 #define IO_OUTPUT_EMPTY         8

 /** @brief Transmission end.*/

 #define IO_TRANSMISSION_END     16

+/** @} */

 

 /**

  * @brief   Type of an I/O condition flags mask.

@@ -267,6 +278,8 @@ typedef uint_fast16_t ioflags_t;
   ioflags_t             flags;

 

 /**

+ * @extends BaseChannelVMT

+ *

  * @brief   @p BaseAsynchronousChannel virtual methods table.

  */

 struct BaseAsynchronousChannelVMT {

@@ -287,6 +300,10 @@ typedef struct {
 } BaseAsynchronousChannel;

 

 /**

+ * @name    Macro Functions (BaseAsynchronousChannel)

+ * @{

+ */

+/**

  * @brief   Returns the I/O condition event source.

  * @details The event source is broadcasted when an I/O condition happens.

  *

@@ -299,7 +316,7 @@ typedef struct {
 #define chIOGetEventSource(ip) (&((ip)->event))

 

 /**

- * @brief   Adds condition flags to the channel's mask.

+ * @brief   Adds status flags to the channel's mask.

  * @details This function is usually called from the I/O ISTs in order to

  *          notify I/O conditions such as data events, errors, signal

  *          changes etc.

@@ -316,7 +333,7 @@ typedef struct {
 }

 

 /**

- * @brief   Returns and clears the errors mask associated to the channel.

+ * @brief   Returns and clears the status flags associated to the channel.

  *

  * @param[in] ip        pointer to a @p BaseAsynchronousChannel or derived

  *                      class

@@ -326,6 +343,7 @@ typedef struct {
  * @api

  */

 #define chIOGetAndClearFlags(ip) ((ip)->vmt->getflags(ip))

+/** @} */

 

 /**

  * @brief   Default implementation of the @p getflags virtual method.