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

Author: Philippe Gerum <r...@xenomai.org>
Date:   Wed Jun 11 19:59:31 2014 +0200

doc: general fixup of the doxygen-based contents hierarchy (WIP)

---

 doc/doxygen/manual-common.conf.in                  |    5 +-
 include/cobalt/kernel/rtdm/analogy/channel_range.h |    2 +-
 include/cobalt/kernel/rtdm/driver.h                |   16 ++--
 include/rtdm/can.h                                 |   39 +++++----
 include/rtdm/rtdm.h                                |   40 +++++----
 include/rtdm/serial.h                              |   15 ++--
 include/rtdm/testing.h                             |   15 ++--
 include/rtdm/uapi/rtdm.h                           |   11 ++-
 kernel/cobalt/rtdm/core.c                          |   88 ++++++++++----------
 kernel/cobalt/rtdm/init.c                          |    2 +
 10 files changed, 123 insertions(+), 110 deletions(-)

diff --git a/doc/doxygen/manual-common.conf.in 
b/doc/doxygen/manual-common.conf.in
index 1541606..71e7423 100644
--- a/doc/doxygen/manual-common.conf.in
+++ b/doc/doxygen/manual-common.conf.in
@@ -860,8 +860,9 @@ DOT_CLEANUP            = YES
 # with spaces.
 
 INPUT                  =                                               \
-                      @top_srcdir@/include/cobalt/kernel               \
-                      @top_srcdir@/kernel/cobalt
+                      @top_srcdir@/include                             \
+                      @top_srcdir@/kernel/cobalt                       \
+                      @top_srcdir@/kernel/drivers
 
 # INPUT                  =                                             \
 #                     @top_srcdir@/include/cobalt                      \
diff --git a/include/cobalt/kernel/rtdm/analogy/channel_range.h 
b/include/cobalt/kernel/rtdm/analogy/channel_range.h
index 5a1f018..2a16e30 100644
--- a/include/cobalt/kernel/rtdm/analogy/channel_range.h
+++ b/include/cobalt/kernel/rtdm/analogy/channel_range.h
@@ -24,7 +24,7 @@
 
 #include <rtdm/uapi/analogy.h>
 
-/*!
+/**
  * @ingroup analogy_driver_facilities
  * @defgroup analogy_channel_range Channels and ranges
  *
diff --git a/include/cobalt/kernel/rtdm/driver.h 
b/include/cobalt/kernel/rtdm/driver.h
index 11df941..030f309 100644
--- a/include/cobalt/kernel/rtdm/driver.h
+++ b/include/cobalt/kernel/rtdm/driver.h
@@ -56,7 +56,7 @@ typedef struct xnselector rtdm_selector_t;
 enum rtdm_selecttype;
 
 /*!
- * @addtogroup devregister
+ * @addtogroup rtdm_device_register
  * @{
  */
 
@@ -83,7 +83,7 @@ enum rtdm_selecttype;
 /*!
  * @anchor drv_versioning @name Driver Versioning
  * Current revisions of RTDM structures, encoding of driver versions. See
- * @ref api_versioning "API Versioning" for the interface revision.
+ * @ref rtdm_api_versioning "API Versioning" for the interface revision.
  * @{
  */
 /** Version of struct rtdm_device */
@@ -109,8 +109,10 @@ enum rtdm_selecttype;
 #define RTDM_DRIVER_PATCH_VER(ver)     ((ver) & 0xFF)
 /** @} Driver Versioning */
 
+/** @} rtdm_device_register */
+
 /*!
- * @addtogroup rtdmsync
+ * @addtogroup rtdm_sync
  * @{
  */
 
@@ -131,7 +133,7 @@ enum rtdm_selecttype {
 };
 /** @} RTDM_SELECTTYPE_xxx */
 
-/** @} rtdmsync */
+/** @} rtdm_sync */
 
 /*!
  * @name Operation Handler Prototypes
@@ -314,7 +316,7 @@ struct rtdm_device {
        /** Device class ID, see @ref RTDM_CLASS_xxx */
        int device_class;
        /** Device sub-class, see RTDM_SUBCLASS_xxx definition in the
-        *  @ref profiles "Device Profiles" */
+        *  @ref rtdm_profiles "Device Profiles" */
        int device_sub_class;
        /** Supported device profile version */
        int profile_version;
@@ -392,7 +394,7 @@ typedef nanosecs_abs_t rtdm_toseq_t;
 void rtdm_toseq_init(rtdm_toseq_t *timeout_seq, nanosecs_rel_t timeout);
 
 /*!
- * @addtogroup rtdmsync
+ * @addtogroup rtdm_sync
  * @{
  */
 
@@ -1136,7 +1138,7 @@ static inline int __rtdm_timedwait(struct rtdm_waitqueue 
*wq,
 
 /** @} Signal, test and wait for a condition atomically */
 
-/** @} rtdmsync */
+/** @} rtdm_sync */
 
 /* --- Interrupt management services --- */
 /*!
diff --git a/include/rtdm/can.h b/include/rtdm/can.h
index 06431ee..a597be8 100644
--- a/include/rtdm/can.h
+++ b/include/rtdm/can.h
@@ -19,8 +19,15 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- * @ingroup rtdm_can
+ */
+#ifndef _RTDM_CAN_H
+#define _RTDM_CAN_H
+
+#include <net/if.h>
+#include <rtdm/rtdm.h>
+#include <rtdm/uapi/can.h>
+
+/**
  * @ingroup rtdm_profiles
  * @defgroup rtdm_can CAN Devices
  *
@@ -218,23 +225,15 @@
  *          successful transmission of the message.
  *
  * @{
- */
-#ifndef _RTDM_CAN_H
-#define _RTDM_CAN_H
-
-#include <net/if.h>
-#include <rtdm/rtdm.h>
-#include <rtdm/uapi/can.h>
-
-/**
+ *
  * @anchor CANutils @name CAN example and utility programs
- * @{ */
-/** @example rtcanconfig.c */
-/** @example rtcansend.c */
-/** @example rtcanrecv.c */
-/** @example rtcan_rtt.c */
-/** @} */
-
-/** @} */
-
+ * @{
+ * @example rtcanconfig.c
+ * @example rtcansend.c
+ * @example rtcanrecv.c
+ * @example rtcan_rtt.c
+ * @}
+ *
+ * @}
+ */
 #endif /* !_RTDM_CAN_H */
diff --git a/include/rtdm/rtdm.h b/include/rtdm/rtdm.h
index 8446587..3933a7e 100644
--- a/include/rtdm/rtdm.h
+++ b/include/rtdm/rtdm.h
@@ -16,7 +16,20 @@
  * You should have received a copy of the GNU General Public License
  * along with Xenomai; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
+ */
+#ifndef _RTDM_RTDM_H
+#define _RTDM_RTDM_H
+
+#include <fcntl.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <errno.h>
+#include <unistd.h>
+#include <sys/ioctl.h>
+#include <sys/socket.h>
+#include <boilerplate/wrappers.h>
+
+/**
  * @defgroup rtdm Real-Time Driver Model
  *
  * The Real-Time Driver Model (RTDM) provides a unified interface to
@@ -26,32 +39,25 @@
  * semantics (IEEE Std 1003.1) where available and applicable.
  *
  * @b API @b Revision: 8
- *
+ */
+
+/**
  * @ingroup rtdm
  * @defgroup rtdm_user_api RTDM User API
  *
+ * Application interface to RTDM services
+ *
  * This is the upper interface of RTDM provided to application
  * programs both in kernel and user space. Note that certain functions
- * may not be implemented by every device. Refer to the @ref profiles
- * "Device Profiles" for precise information.
+ * may not be implemented by every device. Refer to the @ref
+ * rtdm_profiles "Device Profiles" for precise information.
  */
-#ifndef _RTDM_RTDM_H
-#define _RTDM_RTDM_H
-
-#include <fcntl.h>
-#include <stddef.h>
-#include <stdint.h>
-#include <errno.h>
-#include <unistd.h>
-#include <sys/ioctl.h>
-#include <sys/socket.h>
-#include <boilerplate/wrappers.h>
 
 /*
  * Define RTDM_NO_DEFAULT_USER_API to switch off the default
  * rt_dev_xxx interface when providing a customised user API.
  */
-#ifndef RTDM_NO_DEFAULT_USER_API
+#if !defined(RTDM_NO_DEFAULT_USER_API) && !defined(DOXYGEN_CPP)
 
 #define rt_dev_call(__call, __args...) \
 ({                                     \
@@ -70,7 +76,7 @@
 #define rt_dev_sendmsg(__args...)      rt_dev_call(sendmsg, __args)
 #define rt_dev_recvfrom(__args...)     rt_dev_call(recvfrom, __args)
 
-#endif /* !RTDM_NO_DEFAULT_USER_API */
+#endif /* !(RTDM_NO_DEFAULT_USER_API && DOXYGEN_CPP) */
 
 #include <rtdm/uapi/rtdm.h>
 
diff --git a/include/rtdm/serial.h b/include/rtdm/serial.h
index c478543..f014e44 100644
--- a/include/rtdm/serial.h
+++ b/include/rtdm/serial.h
@@ -17,8 +17,14 @@
  * You should have received a copy of the GNU General Public License
  * along with Xenomai; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- * @ingroup rtdm_serial
+ */
+#ifndef _RTDM_SERIAL_H
+#define _RTDM_SERIAL_H
+
+#include <rtdm/rtdm.h>
+#include <rtdm/uapi/serial.h>
+
+/**
  * @ingroup rtdm_profiles
  * @defgroup rtdm_serial Serial Devices
  *
@@ -68,10 +74,5 @@
  * - -EAGAIN (no data written in non-blocking mode)
  * - -EBADF (device has been closed while writing)
  */
-#ifndef _RTDM_SERIAL_H
-#define _RTDM_SERIAL_H
-
-#include <rtdm/rtdm.h>
-#include <rtdm/uapi/serial.h>
 
 #endif /* !_RTDM_SERIAL_H */
diff --git a/include/rtdm/testing.h b/include/rtdm/testing.h
index 677fc16..eb4c45f 100644
--- a/include/rtdm/testing.h
+++ b/include/rtdm/testing.h
@@ -17,8 +17,14 @@
  * You should have received a copy of the GNU General Public License
  * along with Xenomai; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- * @ingroup rtdm_testing
+ */
+#ifndef _RTDM_TESTING_H
+#define _RTDM_TESTING_H
+
+#include <rtdm/rtdm.h>
+#include <rtdm/uapi/testing.h>
+
+/**
  * @ingroup rtdm_profiles
  * @defgroup rtdm_testing Testing Devices
  *
@@ -51,10 +57,5 @@
  * Mandatory Environments: see @ref TSTIOCTLs below @n
  * Specific return values: see @ref TSTIOCTLs below @n
  */
-#ifndef _RTDM_TESTING_H
-#define _RTDM_TESTING_H
-
-#include <rtdm/rtdm.h>
-#include <rtdm/uapi/testing.h>
 
 #endif /* _RTDM_TESTING_H */
diff --git a/include/rtdm/uapi/rtdm.h b/include/rtdm/uapi/rtdm.h
index 3562c69..518d688 100644
--- a/include/rtdm/uapi/rtdm.h
+++ b/include/rtdm/uapi/rtdm.h
@@ -18,8 +18,7 @@
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
- *
- * @ingroup userapi
+ * @ingroup rtdm_user_api
  */
 #ifndef _RTDM_UAPI_RTDM_H
 #define _RTDM_UAPI_RTDM_H
@@ -30,7 +29,7 @@
  */
 
 /*!
- * @anchor api_versioning @name API Versioning
+ * @anchor rtdm_api_versioning @name API Versioning
  * @{ */
 /** Common user and driver API version */
 #define RTDM_API_VER                   9
@@ -62,7 +61,7 @@ typedef int64_t nanosecs_rel_t;
 /** @} rtdm */
 
 /*!
- * @addtogroup profiles
+ * @addtogroup rtdm_profiles
  * @{
  */
 
@@ -112,7 +111,7 @@ typedef struct rtdm_device_info {
        int device_class;
 
        /** Device sub-class, either RTDM_SUBCLASS_GENERIC or a
-        *  RTDM_SUBCLASS_xxx definition of the related @ref profiles
+        *  RTDM_SUBCLASS_xxx definition of the related @ref rtdm_profiles
         *  "Device Profile" */
        int device_sub_class;
 
@@ -130,7 +129,7 @@ typedef struct rtdm_device_info {
 
 /*!
  * @anchor common_IOCTLs    @name Common IOCTLs
- * The following IOCTLs are common to all device profiles.
+ * The following IOCTLs are common to all device rtdm_profiles.
  * @{
  */
 
diff --git a/kernel/cobalt/rtdm/core.c b/kernel/cobalt/rtdm/core.c
index 8d4b4c6..90d6eaf 100644
--- a/kernel/cobalt/rtdm/core.c
+++ b/kernel/cobalt/rtdm/core.c
@@ -31,7 +31,9 @@
 #include <trace/events/cobalt-rtdm.h>
 
 /**
+ * @ingroup rtdm
  * @defgroup rtdm_driver_api Inter-Driver API
+ * RTDM driver-to-driver interface
  * @{
  */
 
@@ -311,7 +313,7 @@ void rtdm_context_put(struct rtdm_dev_context *context);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -324,7 +326,7 @@ int rtdm_open(const char *path, int oflag, ...);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -337,7 +339,7 @@ int rtdm_socket(int protocol_family, int socket_type, int 
protocol);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -350,7 +352,7 @@ int rtdm_close(int fd);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -363,7 +365,7 @@ int rtdm_ioctl(int fd, int request, ...);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -376,7 +378,7 @@ ssize_t rtdm_read(int fd, void *buf, size_t nbyte);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -389,7 +391,7 @@ ssize_t rtdm_write(int fd, const void *buf, size_t nbyte);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -402,7 +404,7 @@ ssize_t rtdm_recvmsg(int fd, struct msghdr *msg, int flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -416,7 +418,7 @@ ssize_t rtdm_recvfrom(int fd, void *buf, size_t len, int 
flags,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -429,7 +431,7 @@ ssize_t rtdm_recv(int fd, void *buf, size_t len, int flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -442,7 +444,7 @@ ssize_t rtdm_sendmsg(int fd, const struct msghdr *msg, int 
flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -456,7 +458,7 @@ ssize_t rtdm_sendto(int fd, const void *buf, size_t len, 
int flags,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -469,7 +471,7 @@ ssize_t rtdm_send(int fd, const void *buf, size_t len, int 
flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -482,7 +484,7 @@ int rtdm_bind(int fd, const struct sockaddr *my_addr, 
socklen_t addrlen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -495,7 +497,7 @@ int rtdm_connect(int fd, const struct sockaddr *serv_addr, 
socklen_t addrlen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -508,7 +510,7 @@ int rtdm_listen(int fd, int backlog);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -521,7 +523,7 @@ int rtdm_accept(int fd, struct sockaddr *addr, socklen_t 
*addrlen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -534,7 +536,7 @@ int rtdm_shutdown(int fd, int how);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -548,7 +550,7 @@ int rtdm_getsockopt(int fd, int level, int optname, void 
*optval,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -562,7 +564,7 @@ int rtdm_setsockopt(int fd, int level, int optname, const 
void *optval,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -575,7 +577,7 @@ int rtdm_getsockname(int fd, struct sockaddr *name, 
socklen_t *namelen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  */
@@ -584,7 +586,7 @@ int rtdm_getpeername(int fd, struct sockaddr *name, 
socklen_t *namelen);
 /** @} */
 
 /*!
- * @addtogroup userapi
+ * @addtogroup rtdm_user_api
  * @{
  */
 
@@ -600,7 +602,7 @@ int rtdm_getpeername(int fd, struct sockaddr *name, 
socklen_t *namelen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -621,7 +623,7 @@ int rt_dev_open(const char *path, int oflag, ...);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -643,7 +645,7 @@ int rt_dev_socket(int protocol_family, int socket_type, int 
protocol);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -664,7 +666,7 @@ int rt_dev_close(int fd);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -684,7 +686,7 @@ int rt_dev_ioctl(int fd, int request, ...);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -704,7 +706,7 @@ ssize_t rt_dev_read(int fd, void *buf, size_t nbyte);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -724,7 +726,7 @@ ssize_t rt_dev_write(int fd, const void *buf, size_t nbyte);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -747,7 +749,7 @@ ssize_t rt_dev_recvmsg(int fd, struct msghdr *msg, int 
flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -769,7 +771,7 @@ ssize_t rt_dev_recvfrom(int fd, void *buf, size_t len, int 
flags,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -789,7 +791,7 @@ ssize_t rt_dev_recv(int fd, void *buf, size_t len, int 
flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -812,7 +814,7 @@ ssize_t rt_dev_sendmsg(int fd, const struct msghdr *msg, 
int flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -834,7 +836,7 @@ ssize_t rt_dev_sendto(int fd, const void *buf, size_t len, 
int flags,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -854,7 +856,7 @@ ssize_t rt_dev_send(int fd, const void *buf, size_t len, 
int flags);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -874,7 +876,7 @@ int rt_dev_bind(int fd, const struct sockaddr *my_addr, 
socklen_t addrlen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -894,7 +896,7 @@ int rt_dev_connect(int fd, const struct sockaddr *serv_addr,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -914,7 +916,7 @@ int rt_dev_listen(int fd, int backlog);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -933,7 +935,7 @@ int rt_dev_accept(int fd, struct sockaddr *addr, socklen_t 
*addrlen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -955,7 +957,7 @@ int rt_dev_shutdown(int fd, int how);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -978,7 +980,7 @@ int rt_dev_getsockopt(int fd, int level, int optname, void 
*optval,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -999,7 +1001,7 @@ int rt_dev_setsockopt(int fd, int level, int optname, 
const void *optval,
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
@@ -1019,7 +1021,7 @@ int rt_dev_getsockname(int fd, struct sockaddr *name, 
socklen_t *namelen);
  *
  * Environments:
  *
- * Depends on driver implementation, see @ref profiles "Device Profiles".
+ * Depends on driver implementation, see @ref rtdm_profiles "Device Profiles".
  *
  * Rescheduling: possible.
  *
diff --git a/kernel/cobalt/rtdm/init.c b/kernel/cobalt/rtdm/init.c
index e6ddf61..8a314a8 100644
--- a/kernel/cobalt/rtdm/init.c
+++ b/kernel/cobalt/rtdm/init.c
@@ -29,6 +29,8 @@
  * @ingroup rtdm
  * @defgroup rtdm_profiles Device Profiles
  *
+ * Pre-defined classes of real-time devices
+ *
  * Device profiles define which operation handlers a driver of a certain class
  * has to implement, which name or protocol it has to register, which IOCTLs
  * it has to provide, and further details. Sub-classes can be defined in order


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

Reply via email to