From 2d55ac3059fcca69cc9736db310b4521064c2b23 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 22 Aug 2011 17:18:52 +0000 Subject: Documentation improvements and code comments reformatting. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3248 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/chevents.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'os/kernel/include/chevents.h') diff --git a/os/kernel/include/chevents.h b/os/kernel/include/chevents.h index e808caec3..f4314aeb2 100644 --- a/os/kernel/include/chevents.h +++ b/os/kernel/include/chevents.h @@ -78,10 +78,14 @@ typedef void (*evhandler_t)(eventid_t); */ #define EVENTSOURCE_DECL(name) EventSource name = _EVENTSOURCE_DATA(name) -/** All events allowed mask.*/ +/** + * @brief All events allowed mask. + */ #define ALL_EVENTS ((eventmask_t)-1) -/** Returns the event mask from the event identifier.*/ +/** + * @brief Returns an event mask from an event identifier. + */ #define EVENT_MASK(eid) ((eventmask_t)(1 << (eid))) /** -- cgit v1.2.3 From c9be79def630f153b0b2d28e905939c15743f989 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Tue, 23 Aug 2011 10:09:08 +0000 Subject: Kernel documentation fixes and improvements. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3251 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/chevents.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'os/kernel/include/chevents.h') diff --git a/os/kernel/include/chevents.h b/os/kernel/include/chevents.h index f4314aeb2..de89118b4 100644 --- a/os/kernel/include/chevents.h +++ b/os/kernel/include/chevents.h @@ -88,6 +88,10 @@ typedef void (*evhandler_t)(eventid_t); */ #define EVENT_MASK(eid) ((eventmask_t)(1 << (eid))) +/** + * @name Macro Functions + * @{ + */ /** * @brief Registers an Event Listener on an Event Source. * @note Multiple Event Listeners can use the same event identifier, the @@ -151,6 +155,7 @@ typedef void (*evhandler_t)(eventid_t); * @iclass */ #define chEvtBroadcastI(esp) chEvtBroadcastFlagsI(esp, 0) +/** @} */ #ifdef __cplusplus extern "C" { -- cgit v1.2.3