Module: xenomai-forge
Branch: next
Commit: f0d56f306d7054e778bd7982fe30e677531c69ac
URL:    
http://git.xenomai.org/?p=xenomai-forge.git;a=commit;h=f0d56f306d7054e778bd7982fe30e677531c69ac

Author: Philippe Gerum <r...@xenomai.org>
Date:   Fri Jun 13 09:59:29 2014 +0200

doc: assorted fixups in doxygen-based contents

---

 doc/doxygen/manual-common.conf.in |   14 ++++++++++++--
 doc/doxygen/manual-html.conf.in   |   10 ----------
 doc/doxygen/manual-pdf.conf.in    |   10 ----------
 include/rtdm/ipc.h                |   12 ------------
 include/rtdm/uapi/can.h           |    3 +++
 include/rtdm/uapi/ipc.h           |   26 +++++++++++++++++++-------
 lib/cobalt/mq.c                   |   24 +++++++++---------------
 lib/cobalt/semaphore.c            |    4 ++--
 8 files changed, 45 insertions(+), 58 deletions(-)

diff --git a/doc/doxygen/manual-common.conf.in 
b/doc/doxygen/manual-common.conf.in
index 02aa816..7cbb1d1 100644
--- a/doc/doxygen/manual-common.conf.in
+++ b/doc/doxygen/manual-common.conf.in
@@ -656,8 +656,10 @@ INCLUDE_FILE_PATTERNS  =
 # or name=definition (no spaces). If the definition and the = are 
 # omitted =1 is assumed.
 
-PREDEFINED = DOXYGEN_CPP \
-        EXPORT_SYMBOL_GPL(symbol)=//
+PREDEFINED = DOXYGEN_CPP               \
+        "EXPORT_SYMBOL_GPL(symbol)=//" \
+       "COBALT_IMPL(T,I,A)=T I A"      \
+       "COBALT_DECL(T,P)=T P"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be 
expanded. 
@@ -870,3 +872,11 @@ INPUT                  =                                   
        \
 EXAMPLE_PATH           =                       \
                       @top_srcdir@/demo/posix  \
                       @top_srcdir@/demo/alchemy
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           = @top_srcdir@/include          \
+                        @top_srcdir@/include/cobalt    \
+                        @top_srcdir@/include/mercury
diff --git a/doc/doxygen/manual-html.conf.in b/doc/doxygen/manual-html.conf.in
index 59f62b5..e9372f5 100644
--- a/doc/doxygen/manual-html.conf.in
+++ b/doc/doxygen/manual-html.conf.in
@@ -194,13 +194,3 @@ LATEX_BATCHMODE        = @LATEX_BATCHMODE@
 # in the output.
 
 LATEX_HIDE_INDICES     = NO
-
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-
-# The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by
-# the preprocessor.
-
-INCLUDE_PATH           =
diff --git a/doc/doxygen/manual-pdf.conf.in b/doc/doxygen/manual-pdf.conf.in
index bf3dc21..fc3de56 100644
--- a/doc/doxygen/manual-pdf.conf.in
+++ b/doc/doxygen/manual-pdf.conf.in
@@ -184,13 +184,3 @@ LATEX_BATCHMODE        = @LATEX_BATCHMODE@
 # in the output.
 
 LATEX_HIDE_INDICES     = NO
-
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor  
-#---------------------------------------------------------------------------
-
-# The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by
-# the preprocessor.
-
-INCLUDE_PATH           =
diff --git a/include/rtdm/ipc.h b/include/rtdm/ipc.h
index b0914e7..d873ea8 100644
--- a/include/rtdm/ipc.h
+++ b/include/rtdm/ipc.h
@@ -24,16 +24,4 @@
 #include <rtdm/rtdm.h>
 #include <rtdm/uapi/ipc.h>
 
-/**
- * @anchor rtipc_examples @name RTIPC examples
- * @{ */
-/** @example bufp-readwrite.c */
-/** @example bufp-label.c */
-/** @example iddp-label.c */
-/** @example iddp-sendrecv.c */
-/** @example xddp-echo.c */
-/** @example xddp-label.c */
-/** @example xddp-stream.c */
-/** @} */
-
 #endif /* !_RTDM_IPC_H */
diff --git a/include/rtdm/uapi/can.h b/include/rtdm/uapi/can.h
index d441b93..08c36a3 100644
--- a/include/rtdm/uapi/can.h
+++ b/include/rtdm/uapi/can.h
@@ -227,14 +227,17 @@ typedef int can_ctrlmode_t;
 enum CAN_STATE {
        /** CAN controller is error active */
        CAN_STATE_ERROR_ACTIVE = 0,
+       /** CAN controller is active */
        CAN_STATE_ACTIVE = 0,
 
        /** CAN controller is error active, warning level is reached */
        CAN_STATE_ERROR_WARNING = 1,
+       /** CAN controller is error active, warning level is reached */
        CAN_STATE_BUS_WARNING = 1,
 
        /** CAN controller is error passive */
        CAN_STATE_ERROR_PASSIVE = 2,
+       /** CAN controller is error passive */
        CAN_STATE_BUS_PASSIVE = 2,
 
        /** CAN controller went into Bus Off */
diff --git a/include/rtdm/uapi/ipc.h b/include/rtdm/uapi/ipc.h
index f125d69..a47b9fc 100644
--- a/include/rtdm/uapi/ipc.h
+++ b/include/rtdm/uapi/ipc.h
@@ -22,11 +22,9 @@
 #ifndef _RTDM_UAPI_IPC_H
 #define _RTDM_UAPI_IPC_H
 
-/*
- *
- * @ingroup rtdm_ipc
+/**
  * @ingroup rtdm_profiles
- * @defgroup rtdm_ipc Real-time IPC protocols
+ * @defgroup rtdm_ipc Real-time IPC
  *
  * @b Profile @b Revision: 1
  * @n
@@ -46,8 +44,9 @@
  * @anchor rtipc_operations @name Supported operations
  * Standard socket operations supported by the RTIPC protocols.
  * @{
- *
- * Create an endpoint for communication in the AF_RTIPC domain.
+ */
+
+/** Create an endpoint for communication in the AF_RTIPC domain.
  *
  * @param[in] domain The communication domain. Must be AF_RTIPC.
  *
@@ -62,7 +61,6 @@
  * - -ENOPROTOOPT (Protocol is known, but not compiled in the RTIPC driver).
  *   See @ref RTIPC_PROTO "RTIPC protocols"
  *   for available protocols.
- * .
  *
  * @par Calling context:
  * non-RT
@@ -78,6 +76,8 @@ int socket__AF_RTIPC(int domain =AF_RTIPC, int type 
=SOCK_DGRAM, int protocol);
  * recvmsg__AF_RTIPC "recvmsg" functions will be unblocked when the socket
  * is closed and return with an error.
  *
+ * @param[in] sockfd The socket descriptor to close.
+ *
  * @return In addition to the standard error codes for @c close(2),
  * the following specific error code may be returned:
  * none
@@ -862,6 +862,18 @@ struct sockaddr_ipc {
 #endif
 /** @} */
 
+/**
+ * @anchor rtdm_ipc_examples @name RTIPC examples
+ * @{ */
+/** @example bufp-readwrite.c */
+/** @example bufp-label.c */
+/** @example iddp-label.c */
+/** @example iddp-sendrecv.c */
+/** @example xddp-echo.c */
+/** @example xddp-label.c */
+/** @example xddp-stream.c */
+/** @} */
+
 /** @} */
 
 #endif /* !_RTDM_UAPI_IPC_H */
diff --git a/lib/cobalt/mq.c b/lib/cobalt/mq.c
index dda0778..147b588 100644
--- a/lib/cobalt/mq.c
+++ b/lib/cobalt/mq.c
@@ -40,7 +40,6 @@
  */
 
 /**
- * @fn int mq_open(const char *name, int oflags, mode_t mode, struct mq_attr 
*attr)
  * @brief Open a message queue
  *
  * This service establishes a connection between the message queue named @a 
name
@@ -134,7 +133,6 @@ COBALT_IMPL(mqd_t, mq_open, (const char *name, int oflags, 
...))
 }
 
 /**
- * @fn int mq_close(mqd_t mqd)
  * @brief Close a message queue
  *
  * This service closes the message queue descriptor @a mqd. The
@@ -159,20 +157,19 @@ COBALT_IMPL(mqd_t, mq_open, (const char *name, int 
oflags, ...))
  * Specification.</a>
  *
  */
-COBALT_IMPL(int, mq_close, (mqd_t q))
+COBALT_IMPL(int, mq_close, (mqd_t mqd))
 {
        int err;
 
-       err = XENOMAI_SKINCALL1(__cobalt_muxid, sc_cobalt_mq_close, q);
+       err = XENOMAI_SKINCALL1(__cobalt_muxid, sc_cobalt_mq_close, mqd);
        if (!err)
-               return __STD(close(q));
+               return __STD(close(mqd));
 
        errno = -err;
        return -1;
 }
 
 /**
- * @fn int mq_unlink(const char *name)
  * @brief Unlink a message queue
  *
  * This service unlinks the message queue named @a name. The message queue is
@@ -213,7 +210,6 @@ COBALT_IMPL(int, mq_unlink, (const char *name))
 }
 
 /**
- * @fn int mq_getattr(mqd_t mqd, struct mq_attr *attr)
  * @brief Get message queue attributes
  *
  * This service stores, at the address @a attr, the attributes of the messages
@@ -239,11 +235,11 @@ COBALT_IMPL(int, mq_unlink, (const char *name))
  * Specification.</a>
  *
  */
-COBALT_IMPL(int, mq_getattr, (mqd_t q, struct mq_attr *attr))
+COBALT_IMPL(int, mq_getattr, (mqd_t mqd, struct mq_attr *attr))
 {
        int err;
 
-       err = XENOMAI_SKINCALL2(__cobalt_muxid, sc_cobalt_mq_getattr, q, attr);
+       err = XENOMAI_SKINCALL2(__cobalt_muxid, sc_cobalt_mq_getattr, mqd, 
attr);
        if (!err)
                return 0;
 
@@ -252,7 +248,6 @@ COBALT_IMPL(int, mq_getattr, (mqd_t q, struct mq_attr 
*attr))
 }
 
 /**
- * @fn int mq_setattr(mqd_t mqd, const struct mq_attr *__restrict__ attr, 
struct mq_attr *__restrict__ oattr)
  * @brief Set message queue attributes
  *
  * This service sets the flags of the @a mqd descriptor to the value
@@ -280,14 +275,14 @@ COBALT_IMPL(int, mq_getattr, (mqd_t q, struct mq_attr 
*attr))
  * Specification.</a>
  *
  */
-COBALT_IMPL(int, mq_setattr, (mqd_t q,
+COBALT_IMPL(int, mq_setattr, (mqd_t mqd,
                              const struct mq_attr *__restrict__ attr,
                              struct mq_attr *__restrict__ oattr))
 {
        int err;
 
        err = XENOMAI_SKINCALL3(__cobalt_muxid,
-                               sc_cobalt_mq_setattr, q, attr, oattr);
+                               sc_cobalt_mq_setattr, mqd, attr, oattr);
        if (!err)
                return 0;
 
@@ -381,7 +376,6 @@ COBALT_IMPL(ssize_t, mq_timedreceive, (mqd_t q,
 }
 
 /**
- * @fn int mq_notify(mqd_t mqd, const struct sigevent *evp)
  * @brief Enable notification on message arrival
  *
  * If @a evp is not @a NULL and is the address of a @b sigevent
@@ -422,12 +416,12 @@ COBALT_IMPL(ssize_t, mq_timedreceive, (mqd_t q,
  * Specification.</a>
  *
  */
-COBALT_IMPL(int, mq_notify, (mqd_t q, const struct sigevent *evp))
+COBALT_IMPL(int, mq_notify, (mqd_t mqd, const struct sigevent *evp))
 {
        int err;
 
        err = XENOMAI_SKINCALL2(__cobalt_muxid,
-                               sc_cobalt_mq_notify, q, evp);
+                               sc_cobalt_mq_notify, mqd, evp);
        if (err) {
                errno = -err;
                return -1;
diff --git a/lib/cobalt/semaphore.c b/lib/cobalt/semaphore.c
index c47943a..efadc4c 100644
--- a/lib/cobalt/semaphore.c
+++ b/lib/cobalt/semaphore.c
@@ -337,7 +337,7 @@ COBALT_IMPL(int, sem_wait, (sem_t *sem))
  * <a 
href="http://www.opengroup.org/onlinepubs/000095399/functions/sem_timedwait.html";>
  * Specification.</a>
  */
-COBALT_IMPL(int, sem_timedwait, (sem_t *sem, const struct timespec *ts))
+COBALT_IMPL(int, sem_timedwait, (sem_t *sem, const struct timespec 
*abs_timeout))
 {
        struct cobalt_sem_shadow *_sem = &((union cobalt_sem_union 
*)sem)->shadow_sem;
        int err, oldtype;
@@ -350,7 +350,7 @@ COBALT_IMPL(int, sem_timedwait, (sem_t *sem, const struct 
timespec *ts))
        pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldtype);
 
        err = -XENOMAI_SKINCALL2(__cobalt_muxid,
-                                sc_cobalt_sem_timedwait, _sem, ts);
+                                sc_cobalt_sem_timedwait, _sem, abs_timeout);
 
        pthread_setcanceltype(oldtype, NULL);
 


_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git

Reply via email to