Skip to contentSkip to conversation

Include RT_MUTEX_INFO in doxygen

PATCH Applied Jan Kiszka 2 participants 2 messages Jul 10, 2008 – Jul 31, 2008

lore
Share & tools
lore

Jan Kiszka

author
#0 lore raw

PATCH 1/2 Include RT_MUTEX_INFO in doxygen

---
 include/native/mutex.h |   10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)
include/native/mutex.h +7 -3
Index: b/include/native/mutex.h
===================================================================
@@ -26,13 +26,17 @@
 
 struct rt_task;
 
+/** Structure containing mutex information useful to users.
+ *
+ *  @see rt_mutex_inquire()
+ */
 typedef struct rt_mutex_info {
 
-	int lockcnt;		/* !< Lock nesting level (> 0 means "locked"). */
+	int lockcnt;		/**< Lock nesting level (> 0 means "locked"). */
 
-	int nwaiters;		/* !< Number of pending tasks. */
+	int nwaiters;		/**< Number of pending tasks. */
 
-	char name[XNOBJECT_NAME_LEN]; /* !< Symbolic name. */
+	char name[XNOBJECT_NAME_LEN]; /**< Symbolic name. */
 
 } RT_MUTEX_INFO;
 
#1 lore raw
Quoted 5 lines · Jan Kiszka
---
 include/native/mutex.h |   10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

Applied, thanks.

Quoted 31 lines

Index: b/include/native/mutex.h
===================================================================

include/native/mutex.h +7 -3
@@ -26,13 +26,17 @@
 
 struct rt_task;
 
+/** Structure containing mutex information useful to users.
+ *
+ *  @see rt_mutex_inquire()
+ */
 typedef struct rt_mutex_info {
 
-	int lockcnt;		/* !< Lock nesting level (> 0 means "locked"). */
+	int lockcnt;		/**< Lock nesting level (> 0 means "locked"). */
 
-	int nwaiters;		/* !< Number of pending tasks. */
+	int nwaiters;		/**< Number of pending tasks. */
 
-	char name[XNOBJECT_NAME_LEN]; /* !< Symbolic name. */
+	char name[XNOBJECT_NAME_LEN]; /**< Symbolic name. */
 
 } RT_MUTEX_INFO;
 

_______________________________________________
Xenomai-core mailing list
[email protected]
https://mail.gna.org/listinfo/xenomai-core

Signature · 1 line
Philippe.