Module: xenomai-forge
Branch: master
Commit: 48b8aa5f212dd412679744f7cdd8a4f5ccb5c4ec
URL:
http://git.xenomai.org/?p=xenomai-forge.git;a=commit;h=48b8aa5f212dd412679744f7cdd8a4f5ccb5c4ec
Author: Philippe Gerum <r...@xenomai.org>
Date: Tue Dec 20 12:09:33 2011 +0100
doc: fix doxygen markup
---
doc/doxygen/Doxyfile-cobalt.in | 11 ++------
doc/doxygen/Doxyfile-common.in | 23 ++---------------
doc/doxygen/Doxyfile-nucleus.in | 8 +-----
doc/doxygen/Doxyfile-rtdm.in | 8 +-----
doc/doxygen/Doxyfile.in | 15 +----------
include/asm-generic/hal.h | 43 ++++++++++++++++++++++++++++++++
include/cobalt/nucleus/sched.h | 4 +-
include/cobalt/nucleus/select.h | 2 +-
include/cobalt/nucleus/vfile.h | 2 +-
include/rtdm/rtdm_driver.h | 8 +++---
include/rtdm/rtipc.h | 27 ++++++++++++++++++++
kernel/cobalt/arch/arm/hal.c | 12 +-------
kernel/cobalt/arch/blackfin/hal.c | 12 +-------
kernel/cobalt/arch/generic/hal.c | 44 ---------------------------------
kernel/cobalt/arch/nios2/hal.c | 12 +-------
kernel/cobalt/arch/powerpc/hal.c | 12 +-------
kernel/cobalt/arch/sh/hal.c | 12 +-------
kernel/cobalt/arch/x86/hal_32.c | 12 +-------
kernel/cobalt/arch/x86/hal_64.c | 12 +-------
kernel/cobalt/cancel.c | 4 +-
kernel/cobalt/clock.c | 4 +-
kernel/cobalt/cond.c | 4 +-
kernel/cobalt/cond_attr.c | 2 +-
kernel/cobalt/module.c | 31 +++++++++++------------
kernel/cobalt/monitor.c | 4 +-
kernel/cobalt/mq.c | 4 +-
kernel/cobalt/mutex.c | 4 +-
kernel/cobalt/mutex_attr.c | 2 +-
kernel/cobalt/nucleus/debug.c | 2 +-
kernel/cobalt/nucleus/pod.c | 2 +-
kernel/cobalt/nucleus/shadow.c | 10 +++----
kernel/cobalt/rtdm/drvlib.c | 8 ++++--
kernel/cobalt/sem.c | 12 ++++----
kernel/cobalt/thread.c | 49 +++++++++++++++++-------------------
kernel/cobalt/timer.c | 17 +++++++------
lib/analogy/range.c | 12 ++++-----
lib/analogy/sys.c | 2 +-
37 files changed, 185 insertions(+), 267 deletions(-)
diff --git a/doc/doxygen/Doxyfile-cobalt.in b/doc/doxygen/Doxyfile-cobalt.in
index 498b8a9..29670e8 100644
--- a/doc/doxygen/Doxyfile-cobalt.in
+++ b/doc/doxygen/Doxyfile-cobalt.in
@@ -5,7 +5,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "Xenomai Cobalt API"
+PROJECT_NAME = "Xenomai Cobalt interface"
# The INPUT tag can be used to specify the files and/or directories that
contain
# documented source files. You may enter file names like "myfile.cpp" or
@@ -15,6 +15,7 @@ PROJECT_NAME = "Xenomai Cobalt API"
INPUT = \
@top_srcdir@/include/cobalt \
@top_srcdir@/kernel/cobalt \
+ @top_srcdir@/include/rtdm \
@top_srcdir@/doc/doxygen
# The EXAMPLE_PATH tag can be used to specify one or more files or
@@ -226,10 +227,4 @@ LATEX_HIDE_INDICES = NO
# contain include files that are not input files but should be processed by
# the preprocessor.
-# Added top_buildir/include here for the definition of XENO_PROTO in
-# xeno_config.h
-INCLUDE_PATH = \
-@top_builddir@/include \
-@top_srcdir@/include \
-@top_srcdir@/include/cobalt \
-
+INCLUDE_PATH =
diff --git a/doc/doxygen/Doxyfile-common.in b/doc/doxygen/Doxyfile-common.in
index 1b6518f..8da171a 100644
--- a/doc/doxygen/Doxyfile-common.in
+++ b/doc/doxygen/Doxyfile-common.in
@@ -651,28 +651,11 @@ INCLUDE_FILE_PATTERNS =
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed.
-PREDEFINED = DOXYGEN_CPP \
- EXPORT_SYMBOL(symbol)=// \
+PREDEFINED = DOXYGEN_CPP \
+ EXPORT_SYMBOL_GPL(symbol)=// \
__KERNEL__ \
CONFIG_XENO_OPT_PIPE \
CONFIG_XENO_OPT_REGISTRY \
- CONFIG_XENO_OPT_PERVASIVE \
- CONFIG_XENO_OPT_TIMING_PERIODIC \
- CONFIG_XENO_OPT_NATIVE_MPS \
- CONFIG_XENO_OPT_NATIVE_PIPE \
- CONFIG_XENO_OPT_NATIVE_REGISTRY \
- CONFIG_XENO_OPT_NATIVE_SEM \
- CONFIG_XENO_OPT_NATIVE_EVENT \
- CONFIG_XENO_OPT_NATIVE_MUTEX \
- CONFIG_XENO_OPT_NATIVE_COND \
- CONFIG_XENO_OPT_NATIVE_QUEUE \
- CONFIG_XENO_OPT_NATIVE_HEAP \
- CONFIG_XENO_OPT_NATIVE_ALARM \
- CONFIG_XENO_OPT_NATIVE_INTR \
- CONFIG_XENO_OPT_POSIX_INTR \
- CONFIG_XENO_OPT_RTAI_FIFO \
- CONFIG_XENO_OPT_RTAI_SEM \
- CONFIG_XENO_OPT_RTAI_SHM \
CONFIG_XENO_OPT_RTDM_SELECT
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
@@ -680,7 +663,7 @@ PREDEFINED = DOXYGEN_CPP \
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
-EXPAND_AS_DEFINED = XENO_PROTO
+EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
diff --git a/doc/doxygen/Doxyfile-nucleus.in b/doc/doxygen/Doxyfile-nucleus.in
index 6c377a8..7695b47 100644
--- a/doc/doxygen/Doxyfile-nucleus.in
+++ b/doc/doxygen/Doxyfile-nucleus.in
@@ -220,10 +220,4 @@ LATEX_HIDE_INDICES = NO
# contain include files that are not input files but should be processed by
# the preprocessor.
-# Added top_buildir/include here for the definition of XENO_PROTO in
-# xeno_config.h
-INCLUDE_PATH = \
-@top_builddir@/include \
-@top_srcdir@/include
-
-
+INCLUDE_PATH =
diff --git a/doc/doxygen/Doxyfile-rtdm.in b/doc/doxygen/Doxyfile-rtdm.in
index 37c93c0..e468a19 100644
--- a/doc/doxygen/Doxyfile-rtdm.in
+++ b/doc/doxygen/Doxyfile-rtdm.in
@@ -226,10 +226,4 @@ LATEX_HIDE_INDICES = NO
# contain include files that are not input files but should be processed by
# the preprocessor.
-# Added top_buildir/include here for the definition of XENO_PROTO in
-# xeno_config.h
-INCLUDE_PATH = \
-@top_srcdir@/kernel/cobalt/rtdm \
-@top_builddir@/include \
-@top_srcdir@/include
-
+INCLUDE_PATH =
diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in
index 347077a..1a3a90c 100644
--- a/doc/doxygen/Doxyfile.in
+++ b/doc/doxygen/Doxyfile.in
@@ -239,17 +239,4 @@ LATEX_HIDE_INDICES = NO
# contain include files that are not input files but should be processed by
# the preprocessor.
-# Added top_buildir/include here for the definition of XENO_PROTO in
-# xeno_config.h
-INCLUDE_PATH = \
-@top_srcdir@/kernel/cobalt \
-@top_srcdir@/kernel/drivers \
-@top_builddir@/include \
-@top_srcdir@/include \
-@top_srcdir@/include/copperplate \
-@top_srcdir@/include/cobalt \
-@top_srcdir@/include/cobalt/nucleus \
-@top_srcdir@/include/alchemy \
-@top_srcdir@/include/psos \
-@top_srcdir@/include/vxworks \
-@top_srcdir@/include/analogy
+INCLUDE_PATH =
diff --git a/include/asm-generic/hal.h b/include/asm-generic/hal.h
index 04acab2..bcfe003 100644
--- a/include/asm-generic/hal.h
+++ b/include/asm-generic/hal.h
@@ -419,6 +419,26 @@ int rthal_irq_disable(unsigned irq);
int rthal_irq_end(unsigned irq);
+/**
+ * @fn static inline void rthal_irq_host_pend(unsigned irq)
+ *
+ * @brief Propagate an IRQ event to Linux.
+ *
+ * Causes the given IRQ to be propagated down to the Adeos pipeline to
+ * the Linux kernel. This operation is typically used after the given
+ * IRQ has been processed into the Xenomai domain by a real-time
+ * interrupt handler (see rthal_irq_request()), in case such interrupt
+ * must also be handled by the Linux kernel.
+ *
+ * @param irq The interrupt number to propagate. This value is
+ * architecture-dependent.
+ *
+ * Environments:
+ *
+ * This service can be called from:
+ *
+ * - Xenomai domain context.
+ */
static inline void rthal_irq_host_pend(unsigned irq)
{
rthal_propagate_irq(irq);
@@ -437,6 +457,29 @@ static inline void __rthal_apc_schedule(int apc)
rthal_schedule_irq_root(rthal_apc_virq);
}
+/**
+ * @fn static inline int rthal_apc_schedule(int apc)
+ *
+ * @brief Schedule an APC invocation.
+ *
+ * This service marks the APC as pending for the Linux domain, so that
+ * its handler will be called as soon as possible, when the Linux
+ * domain gets back in control.
+ *
+ * When posted from the Linux domain, the APC handler is fired as soon
+ * as the interrupt mask is explicitly cleared by some kernel
+ * code. When posted from the Xenomai domain, the APC handler is
+ * fired as soon as the Linux domain is resumed, i.e. after Xenomai has
+ * completed all its pending duties.
+ *
+ * @param apc The APC id. to schedule.
+ *
+ * This service can be called from:
+ *
+ * - Any domain context, albeit the usual calling place is from the
+ * Xenomai domain.
+ */
+
static inline void rthal_apc_schedule(int apc)
{
unsigned long flags;
diff --git a/include/cobalt/nucleus/sched.h b/include/cobalt/nucleus/sched.h
index 8915754..84864d2 100644
--- a/include/cobalt/nucleus/sched.h
+++ b/include/cobalt/nucleus/sched.h
@@ -1,4 +1,4 @@
-/*!\file sched.h
+/**\file
* \brief Scheduler interface header.
* \author Philippe Gerum
*
@@ -263,7 +263,7 @@ void xnsched_migrate_passive(struct xnthread *thread,
struct xnsched *sched);
/*!
- * \fn void xnsched_rotate(struct xnsched *sched, struct xnsched_class
*sched_class, const union xnsched_policy_param *param)
+ * \fn void xnsched_rotate(struct xnsched *sched, struct xnsched_class
*sched_class, const union xnsched_policy_param *sched_param)
* \brief Rotate a scheduler runqueue.
*
* The specified scheduling class is requested to rotate its runqueue
diff --git a/include/cobalt/nucleus/select.h b/include/cobalt/nucleus/select.h
index d6f51f8..31c9cac 100644
--- a/include/cobalt/nucleus/select.h
+++ b/include/cobalt/nucleus/select.h
@@ -1,4 +1,4 @@
-/*!\file select.h
+/**\file
* \brief file descriptors events multiplexing header.
* \author Gilles Chanteperdrix
*
diff --git a/include/cobalt/nucleus/vfile.h b/include/cobalt/nucleus/vfile.h
index 1380c8f..4bac727 100644
--- a/include/cobalt/nucleus/vfile.h
+++ b/include/cobalt/nucleus/vfile.h
@@ -243,7 +243,7 @@ struct xnvfile_regular_ops {
* @return the number of bytes read from the input descriptor
* if the call succeeds. Otherwise, a negative error code.
* Return values from parsing helper routines are commonly
- * passed back to the caller by the @ref show_store
+ * passed back to the caller by the @ref regular_store
* "store() handler".
*
* @note This handler is optional, and may be omitted for
diff --git a/include/rtdm/rtdm_driver.h b/include/rtdm/rtdm_driver.h
index b3b4dd9..50a96aa 100644
--- a/include/rtdm/rtdm_driver.h
+++ b/include/rtdm/rtdm_driver.h
@@ -1039,16 +1039,16 @@ typedef xnthread_t rtdm_task_t;
*/
typedef void (*rtdm_task_proc_t)(void *arg);
-/*!
- * @anchor taskprio @name Task Priority Range
+/**
+ * @anchor rtdmtaskprio @name Task Priority Range
* Maximum and minimum task priorities
* @{ */
#define RTDM_TASK_LOWEST_PRIORITY XNSCHED_LOW_PRIO
#define RTDM_TASK_HIGHEST_PRIORITY XNSCHED_HIGH_PRIO
/** @} Task Priority Range */
-/*!
- * @anchor changetaskprio @name Task Priority Modification
+/**
+ * @anchor rtdmchangetaskprio @name Task Priority Modification
* Raise or lower task priorities by one level
* @{ */
#define RTDM_TASK_RAISE_PRIORITY (+1)
diff --git a/include/rtdm/rtipc.h b/include/rtdm/rtipc.h
index 4b06dbc..9819bfd 100644
--- a/include/rtdm/rtipc.h
+++ b/include/rtdm/rtipc.h
@@ -48,6 +48,10 @@
/**
* Create an endpoint for communication in the AF_RTIPC domain.
*
+ * @param[in] domain The communication domain. Must be AF_RTIPC.
+ *
+ * @param[in] type The socket type. Must be SOCK_DGRAM.
+ *
* @param [in] protocol Any of @ref IPCPROTO_XDDP, @ref IPCPROTO_IDDP,
* or @ref IPCPROTO_BUFP. @ref IPCPROTO_IPC is also valid, and refers
* to the default RTIPC protocol, namely @ref IPCPROTO_IDDP.
@@ -89,6 +93,9 @@ int close__AF_RTIPC(int sockfd);
*
* Bind the socket to a destination port.
*
+ * @param[in] sockfd The RTDM file descriptor obtained from the socket
+ * creation call.
+ *
* @param [in] addr The address to bind the socket to (see struct
* sockaddr_ipc). The meaning of such address depends on the RTIPC
* protocol in use for the socket:
@@ -157,6 +164,9 @@ int close__AF_RTIPC(int sockfd);
* the label string passed to setsockopt() for the @a BUFP_LABEL
* option.
*
+ * @param[in] addrlen The size in bytes of the structure pointed to by
+ * @a addr.
+ *
* @return In addition to the standard error codes for @c
* bind(2), the following specific error code may be returned:
* - -EFAULT (Invalid data address given)
@@ -176,6 +186,9 @@ int bind__AF_RTIPC(int sockfd, const struct sockaddr_ipc
*addr,
/**
* Initiate a connection on a RTIPC socket.
*
+ * @param[in] sockfd The RTDM file descriptor obtained from the socket
+ * creation call.
+ *
* @param [in] addr The address to connect the socket to (see struct
* sockaddr_ipc).
*
@@ -194,6 +207,9 @@ int bind__AF_RTIPC(int sockfd, const struct sockaddr_ipc
*addr,
* write to the socket will return -EDESTADDRREQ, until a valid
* destination address is set via @c connect(2) or @c bind(2).
*
+ * @param[in] addrlen The size in bytes of the structure pointed to by
+ * @a addr.
+ *
* @return In addition to the standard error codes for @c connect(2),
* the following specific error code may be returned:
* none.
@@ -258,6 +274,12 @@ int getsockopt__AF_RTIPC(int sockfd, int level, int
optname,
/**
* Send a message on a RTIPC socket.
*
+ * @param[in] sockfd The RTDM file descriptor obtained from the socket
+ * creation call.
+ *
+ * @param[in] msg The address of the message header conveying the
+ * datagram.
+ *
* @param [in] flags Operation flags:
*
* - MSG_OOB Send out-of-band message. For all RTIPC protocols except
@@ -297,6 +319,11 @@ ssize_t sendmsg__AF_RTIPC(int sockfd, const struct msghdr
*msg, int flags);
/**
* Receive a message from a RTIPC socket.
*
+ * @param[in] sockfd The RTDM file descriptor obtained from the socket
+ * creation call.
+ *
+ * @param[out] msg The address the message header will be copied at.
+ *
* @param [in] flags Operation flags:
*
* - MSG_DONTWAIT Non-blocking I/O operation. The caller will not be
diff --git a/kernel/cobalt/arch/arm/hal.c b/kernel/cobalt/arch/arm/hal.c
index 2a27b3e..1455c55 100644
--- a/kernel/cobalt/arch/arm/hal.c
+++ b/kernel/cobalt/arch/arm/hal.c
@@ -22,15 +22,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * ARM-specific HAL services.
*
- *@{*/
-
+ * ARM-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -399,8 +393,6 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/arm stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
EXPORT_SYMBOL_GPL(rthal_thread_switch);
diff --git a/kernel/cobalt/arch/blackfin/hal.c
b/kernel/cobalt/arch/blackfin/hal.c
index 5324268..1377a69 100644
--- a/kernel/cobalt/arch/blackfin/hal.c
+++ b/kernel/cobalt/arch/blackfin/hal.c
@@ -22,15 +22,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * Blackfin-specific HAL services.
*
- *@{*/
-
+ * Blackfin-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -291,8 +285,6 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/blackfin stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
EXPORT_SYMBOL_GPL(rthal_thread_switch);
diff --git a/kernel/cobalt/arch/generic/hal.c b/kernel/cobalt/arch/generic/hal.c
index 353637a..c48bcab 100644
--- a/kernel/cobalt/arch/generic/hal.c
+++ b/kernel/cobalt/arch/generic/hal.c
@@ -208,27 +208,6 @@ int rthal_irq_release(unsigned irq)
}
/**
- * @fn void rthal_irq_host_pend (unsigned irq)
- *
- * @brief Propagate an IRQ event to Linux.
- *
- * Causes the given IRQ to be propagated down to the Adeos pipeline to
- * the Linux kernel. This operation is typically used after the given
- * IRQ has been processed into the Xenomai domain by a real-time
- * interrupt handler (see rthal_irq_request()), in case such interrupt
- * must also be handled by the Linux kernel.
- *
- * @param irq The interrupt number to propagate. This value is
- * architecture-dependent.
- *
- * Environments:
- *
- * This service can be called from:
- *
- * - Xenomai domain context.
- */
-
-/**
* @fn int rthal_trap_catch (rthal_trap_handler_t handler)
*
* @brief Installs a fault handler.
@@ -683,29 +662,6 @@ unsigned long long __rthal_generic_full_divmod64(unsigned
long long a,
* - Linux domain context.
*/
-/**
- * @fn int rthal_apc_schedule (int apc)
- *
- * @brief Schedule an APC invocation.
- *
- * This service marks the APC as pending for the Linux domain, so that
- * its handler will be called as soon as possible, when the Linux
- * domain gets back in control.
- *
- * When posted from the Linux domain, the APC handler is fired as soon
- * as the interrupt mask is explicitly cleared by some kernel
- * code. When posted from the Xenomai domain, the APC handler is
- * fired as soon as the Linux domain is resumed, i.e. after Xenomai has
- * completed all its pending duties.
- *
- * @param apc The APC id. to schedule.
- *
- * This service can be called from:
- *
- * - Any domain context, albeit the usual calling place is from the
- * Xenomai domain.
- */
-
/*@}*/
EXPORT_SYMBOL_GPL(rthal_irq_request);
diff --git a/kernel/cobalt/arch/nios2/hal.c b/kernel/cobalt/arch/nios2/hal.c
index 10748cf..d7e90f8 100644
--- a/kernel/cobalt/arch/nios2/hal.c
+++ b/kernel/cobalt/arch/nios2/hal.c
@@ -22,15 +22,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * NIOS2-specific HAL services.
*
- *@{*/
-
+ * NIOS2-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -162,8 +156,6 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/nios2 stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
EXPORT_SYMBOL_GPL(rthal_thread_switch);
diff --git a/kernel/cobalt/arch/powerpc/hal.c b/kernel/cobalt/arch/powerpc/hal.c
index b023819..874f3cf 100644
--- a/kernel/cobalt/arch/powerpc/hal.c
+++ b/kernel/cobalt/arch/powerpc/hal.c
@@ -24,15 +24,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * PowerPC-specific HAL services.
*
- *@{*/
-
+ * PowerPC-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -334,8 +328,6 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/powerpc stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
EXPORT_SYMBOL_GPL(rthal_thread_switch);
diff --git a/kernel/cobalt/arch/sh/hal.c b/kernel/cobalt/arch/sh/hal.c
index a25b725..608bcdc 100644
--- a/kernel/cobalt/arch/sh/hal.c
+++ b/kernel/cobalt/arch/sh/hal.c
@@ -22,15 +22,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * SuperH-specific HAL services.
*
- *@{*/
-
+ * SuperH-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -200,7 +194,5 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/SuperH stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
diff --git a/kernel/cobalt/arch/x86/hal_32.c b/kernel/cobalt/arch/x86/hal_32.c
index b91eace..f4276df 100644
--- a/kernel/cobalt/arch/x86/hal_32.c
+++ b/kernel/cobalt/arch/x86/hal_32.c
@@ -29,15 +29,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * i386-specific HAL services.
*
- *@{*/
-
+ * i386-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -264,7 +258,5 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/i386 stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
diff --git a/kernel/cobalt/arch/x86/hal_64.c b/kernel/cobalt/arch/x86/hal_64.c
index f392b32..5ffd6a0 100644
--- a/kernel/cobalt/arch/x86/hal_64.c
+++ b/kernel/cobalt/arch/x86/hal_64.c
@@ -22,15 +22,9 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
- */
-
-/**
- * @addtogroup hal
- *
- * x86_64-specific HAL services.
*
- *@{*/
-
+ * x86_64-specific HAL services.
+ */
#include <linux/version.h>
#include <linux/slab.h>
#include <linux/errno.h>
@@ -90,7 +84,5 @@ void rthal_arch_cleanup(void)
printk(KERN_INFO "Xenomai: hal/x86_64 stopped.\n");
}
-/*@}*/
-
EXPORT_SYMBOL_GPL(rthal_arch_init);
EXPORT_SYMBOL_GPL(rthal_arch_cleanup);
diff --git a/kernel/cobalt/cancel.c b/kernel/cobalt/cancel.c
index 32a5b4b..a9a05ef 100644
--- a/kernel/cobalt/cancel.c
+++ b/kernel/cobalt/cancel.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix_thread
- * @defgroup posix_cancel Thread cancellation.
+ * @ingroup cobalt_thread
+ * @defgroup cobalt_cancel Thread cancellation.
*
* Thread cancellation.
*
diff --git a/kernel/cobalt/clock.c b/kernel/cobalt/clock.c
index 95f783d..5303ee0 100644
--- a/kernel/cobalt/clock.c
+++ b/kernel/cobalt/clock.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_time Clocks and timers services.
+ * @ingroup cobalt
+ * @defgroup cobalt_time Clocks and timers services.
*
* Clocks and timers services.
*
diff --git a/kernel/cobalt/cond.c b/kernel/cobalt/cond.c
index cfe5201..b72a2f2 100644
--- a/kernel/cobalt/cond.c
+++ b/kernel/cobalt/cond.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_cond Condition variables services.
+ * @ingroup cobalt
+ * @defgroup cobalt_cond Condition variables services.
*
* Condition variables services.
*
diff --git a/kernel/cobalt/cond_attr.c b/kernel/cobalt/cond_attr.c
index f14d5d6..e3102bd 100644
--- a/kernel/cobalt/cond_attr.c
+++ b/kernel/cobalt/cond_attr.c
@@ -17,7 +17,7 @@
*/
/**
- * @addtogroup posix_cond
+ * @addtogroup cobalt_cond
*
*@{*/
diff --git a/kernel/cobalt/module.c b/kernel/cobalt/module.c
index b481c30..3bf3b53 100644
--- a/kernel/cobalt/module.c
+++ b/kernel/cobalt/module.c
@@ -22,25 +22,24 @@
* Xenomai POSIX skin is an implementation of a small subset of the Single
* Unix specification over Xenomai generic RTOS core.
*
- * The following table gives equivalence between Alchemy API services
- * and POSIX services.
+ * The following table gives equivalence between Alchemy services and
+ * Cobalt services.
*
* <CENTER>
* <TABLE>
- * <TR><TH>Native API services</TH> <TH>POSIX API services</TH></TR>
- * <TR><TD>@ref alarm</TD> <TD>@ref posix_time</TD></TR>
- * <TR><TD>@ref cond</TD> <TD>@ref posix_cond</TD></TR>
- * <TR><TD>@ref event</TD> <TD>no direct equivalence, <BR>
- * see @ref posix_cond</TD></TR>
- * <TR><TD>@ref alchemy_heap</TD> <TD>@ref posix_shm</TD></TR>
- * <TR><TD>@ref interrupt</TD> <TD>@ref posix_intr</TD></TR>
- * <TR><TD>@ref mutex</TD> <TD>@ref posix_mutex</TD></TR>
- * <TR><TD>@ref pipe</TD> <TD>no direct equivalence, <BR>
- * see @ref posix_mq</TD></TR>
- * <TR><TD>@ref alchemy_queue</TD> <TD>@ref posix_mq</TD></TR>
- * <TR><TD>@ref semaphore</TD> <TD>@ref posix_sem</TD></TR>
- * <TR><TD>@ref task</TD> <TD>@ref posix_thread</TD></TR>
- * <TR><TD>@ref alchemy_timer</TD> <TD>@ref posix_time</TD></TR>
+ * <TR><TH>Alchemy services</TH> <TH>Cobalt services</TH></TR>
+ * <TR><TD>@ref alchemy_alarm</TD> <TD>@ref cobalt_time</TD></TR>
+ * <TR><TD>@ref alchemy_cond</TD> <TD>@ref cobalt_cond</TD></TR>
+ * <TR><TD>@ref alchemy_event</TD> <TD>no direct equivalence, <BR>
+ * see @ref cobalt_cond</TD></TR>
+ * <TR><TD>@ref alchemy_heap</TD> <TD>no direct equivalence<BR>
+ * <TR><TD>@ref alchemy_mutex</TD> <TD>@ref cobalt_mutex</TD></TR>
+ * <TR><TD>@ref alchemy_pipe</TD> <TD>no direct equivalence, <BR>
+ * see @ref cobalt_mq</TD></TR>
+ * <TR><TD>@ref alchemy_queue</TD> <TD>@ref cobalt_mq</TD></TR>
+ * <TR><TD>@ref alchemy_sem</TD> <TD>@ref cobalt_sem</TD></TR>
+ * <TR><TD>@ref alchemy_task</TD> <TD>@ref cobalt_thread</TD></TR>
+ * <TR><TD>@ref alchemy_timer</TD> <TD>@ref cobalt_time</TD></TR>
* </TABLE>
* </CENTER>
*
diff --git a/kernel/cobalt/monitor.c b/kernel/cobalt/monitor.c
index e3c08ea..1416398 100644
--- a/kernel/cobalt/monitor.c
+++ b/kernel/cobalt/monitor.c
@@ -18,8 +18,8 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
- * \ingroup posix
- * \defgroup monitor Synchronization monitor services
+ * \ingroup cobalt
+ * \defgroup cobalt_monitor Synchronization monitor services
*
* Synchronization monitor services
*
diff --git a/kernel/cobalt/mq.c b/kernel/cobalt/mq.c
index 8894f05..8b06165 100644
--- a/kernel/cobalt/mq.c
+++ b/kernel/cobalt/mq.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_mq Message queues services.
+ * @ingroup cobalt
+ * @defgroup cobalt_mq Message queues services.
*
* Message queues services.
*
diff --git a/kernel/cobalt/mutex.c b/kernel/cobalt/mutex.c
index 3da89a3..99f65c0 100644
--- a/kernel/cobalt/mutex.c
+++ b/kernel/cobalt/mutex.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_mutex Mutex services.
+ * @ingroup cobalt
+ * @defgroup cobalt_mutex Mutex services.
*
* Mutex services.
*
diff --git a/kernel/cobalt/mutex_attr.c b/kernel/cobalt/mutex_attr.c
index 4729840..292e23e 100644
--- a/kernel/cobalt/mutex_attr.c
+++ b/kernel/cobalt/mutex_attr.c
@@ -17,7 +17,7 @@
*/
/**
- * @addtogroup posix_mutex
+ * @addtogroup cobalt_mutex
*
*@{*/
diff --git a/kernel/cobalt/nucleus/debug.c b/kernel/cobalt/nucleus/debug.c
index 117813a..6e33115 100644
--- a/kernel/cobalt/nucleus/debug.c
+++ b/kernel/cobalt/nucleus/debug.c
@@ -1,4 +1,4 @@
-/*!\file debug.c
+/*!\file
* \brief Debug services.
* \author Philippe Gerum
*
diff --git a/kernel/cobalt/nucleus/pod.c b/kernel/cobalt/nucleus/pod.c
index d8ee29d..c6deedb 100644
--- a/kernel/cobalt/nucleus/pod.c
+++ b/kernel/cobalt/nucleus/pod.c
@@ -784,7 +784,7 @@ EXPORT_SYMBOL_GPL(xnpod_start_thread);
/*!
* @internal
- * \fn void __xnpod_reset_thread(struct xnthread *thread, int unlock)
+ * \fn void __xnpod_reset_thread(struct xnthread *thread)
* \brief Reset the thread.
*
* This internal routine resets the state of a thread so that it can
diff --git a/kernel/cobalt/nucleus/shadow.c b/kernel/cobalt/nucleus/shadow.c
index ab4ed2d..89570d3 100644
--- a/kernel/cobalt/nucleus/shadow.c
+++ b/kernel/cobalt/nucleus/shadow.c
@@ -870,12 +870,10 @@ void xnshadow_exit(void)
do_exit(0);
}
-/*!
- * \fn int xnshadow_map(xnthread_t *thread,
- * xncompletion_t __user *u_completion,
- * unsigned long __user *u_mode_offset)
+/**
+ * @fn int xnshadow_map(xnthread_t *thread, xncompletion_t __user
*u_completion, unsigned long __user *u_mode_offset)
* @internal
- * \brief Create a shadow thread context.
+ * @brief Create a shadow thread context.
*
* This call maps a nucleus thread to the "current" Linux task. The
* priority and scheduling class of the underlying Linux task are not
@@ -897,7 +895,7 @@ void xnshadow_exit(void)
* immediately started and "current" immediately resumes in the Xenomai
* domain from this service.
*
- * @param: u_mode_offset is the address of a user space address where
+ * @param u_mode_offset is the address of a user space address where
* we will store the offset of the "u_mode" thread variable in the
* process shared heap. This thread variable reflects the current
* thread mode (primary or secondary). The nucleus will try to update
diff --git a/kernel/cobalt/rtdm/drvlib.c b/kernel/cobalt/rtdm/drvlib.c
index fa751a8..940d393 100644
--- a/kernel/cobalt/rtdm/drvlib.c
+++ b/kernel/cobalt/rtdm/drvlib.c
@@ -43,11 +43,12 @@
/*!
* @ingroup driverapi
- * @defgroup clock Clock Services
+ * @defgroup rtdmclock Clock Services
* @{
*/
#ifdef DOXYGEN_CPP /* Only used for doxygen doc generation */
+
/**
* @brief Get system time
*
@@ -120,7 +121,7 @@ nanosecs_abs_t rtdm_clock_read_monotonic(void);
* @param[in] task_proc Procedure to be executed by the task
* @param[in] arg Custom argument passed to @c task_proc() on entry
* @param[in] priority Priority of the task, see also
- * @ref taskprio "Task Priority Range"
+ * @ref rtdmtaskprio "Task Priority Range"
* @param[in] period Period in nanoseconds of a cyclic task, 0 for non-cyclic
* mode
*
@@ -212,7 +213,7 @@ void rtdm_task_destroy(rtdm_task_t *task);
*
* @param[in,out] task Task handle as returned by rtdm_task_init()
* @param[in] priority New priority of the task, see also
- * @ref taskprio "Task Priority Range"
+ * @ref rtdmtaskprio "Task Priority Range"
*
* Environments:
*
@@ -734,6 +735,7 @@ void rtdm_toseq_init(rtdm_toseq_t *timeout_seq,
nanosecs_rel_t timeout)
}
EXPORT_SYMBOL_GPL(rtdm_toseq_init);
+
/** @} */
/*!
diff --git a/kernel/cobalt/sem.c b/kernel/cobalt/sem.c
index e650fac..d697869 100644
--- a/kernel/cobalt/sem.c
+++ b/kernel/cobalt/sem.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_sem Semaphores services.
+ * @ingroup cobalt
+ * @defgroup cobalt_sem Semaphores services.
*
* Semaphores services.
*
@@ -492,7 +492,7 @@ static inline int sem_trywait_internal(cobalt_sem_t *sem)
* immediately if the semaphore @a sm is currently depleted, and that
* it is not a cancellation point.
*
- * @param sm the semaphore to be decremented.
+ * @param sem the semaphore to be decremented.
*
* @retval 0 on success;
* @retval -1 with @a errno set if:
@@ -560,7 +560,7 @@ sem_timedwait_internal(cobalt_sem_t *sem, int timed,
xnticks_t to)
* blocked in a call to this service, the semaphore state is left unchanged
* before the cancellation cleanup handlers are called.
*
- * @param sm the semaphore to be decremented.
+ * @param sem the semaphore to be decremented.
*
* @retval 0 on success;
* @retval -1 with @a errno set if:
@@ -598,7 +598,7 @@ static int sem_wait(cobalt_sem_t *sem)
* This service is equivalent to sem_wait(), except that the caller is only
* blocked until the timeout @a abs_timeout expires.
*
- * @param sm the semaphore to be decremented;
+ * @param sem the semaphore to be decremented;
*
* @param abs_timeout the timeout, expressed as an absolute value of
* the relevant clock for the semaphore, either CLOCK_MONOTONIC if
@@ -717,7 +717,7 @@ static int sem_post(cobalt_sem_t *sm)
* semaphore is fully depleted AND two threads are currently pending
* on it).
*
- * @param sm a semaphore;
+ * @param sem a semaphore;
*
* @param value address where the semaphore count will be stored on success.
*
diff --git a/kernel/cobalt/thread.c b/kernel/cobalt/thread.c
index c4120ad..1cd20b2 100644
--- a/kernel/cobalt/thread.c
+++ b/kernel/cobalt/thread.c
@@ -17,8 +17,8 @@
*/
/**
- * @ingroup posix
- * @defgroup posix_thread Threads management services.
+ * @ingroup cobalt
+ * @defgroup cobalt_thread Threads management services.
*
* Threads management services.
*
@@ -328,19 +328,19 @@ unlock_and_exit:
/**
* Create a thread.
*
- * This service create a thread. The created thread may be used with all POSIX
- * skin services.
+ * This service creates a Cobalt thread control block. The created
+ * thread may use Cobalt API services.
*
- * The new thread run the @a start routine, with the @a arg argument.
+ * The new thread control block can be mapped over a regular Linux
+ * thread, forming a Xenomai shadow.
*
* The new thread signal mask is inherited from the current thread, if it was
* also created with pthread_create(), otherwise the new thread signal mask is
* empty.
*
- * Other attributes of the new thread depend on the @a attr argument. If
- * @a attr is null, default values for these attributes are used. See @ref
- * posix_threadattr for a definition of thread creation attributes and their
- * default values.
+ * Other attributes of the new thread depend on the @a attr
+ * argument. If @a attr is null, default values for these attributes
+ * are used.
*
* Returning from the @a start routine has the same effect as calling
* pthread_exit() with the return value.
@@ -350,10 +350,6 @@ unlock_and_exit:
*
* @param attr thread attributes;
*
- * @param start thread routine;
- *
- * @param arg thread routine argument.
- *
* @return 0 on success;
* @return an error number if:
* - EINVAL, @a attr is invalid;
@@ -369,22 +365,23 @@ unlock_and_exit:
* @note
*
* When creating or shadowing a Xenomai thread for the first time in
- * user-space, Xenomai installs a handler for the SIGWINCH signal. If you had
- * installed a handler before that, it will be automatically called by Xenomai
- * for SIGWINCH signals that it has not sent.
- *
- * If, however, you install a signal handler for SIGWINCH after creating
- * or shadowing the first Xenomai thread, you have to explicitly call the
- * function xeno_sigwinch_handler at the beginning of your signal handler,
- * using its return to know if the signal was in fact an internal signal of
- * Xenomai (in which case it returns 1), or if you should handle the signal (in
- * which case it returns 0). xeno_sigwinch_handler prototype is:
+ * user-space, Xenomai installs a handler for the SIGWINCH signal. If
+ * you had installed a handler before that, it will be automatically
+ * called by Xenomai for SIGWINCH signals that it has not sent.
+ *
+ * If, however, you install a signal handler for SIGWINCH after
+ * creating or shadowing the first Xenomai thread, you have to
+ * explicitly call the function xeno_sigwinch_handler at the beginning
+ * of your signal handler, using its return to know if the signal was
+ * in fact an internal signal of Xenomai (in which case it returns 1),
+ * or if you should handle the signal (in which case it returns
+ * 0). xeno_sigwinch_handler prototype is:
*
* <b>int xeno_sigwinch_handler(int sig, siginfo_t *si, void *ctxt);</b>
*
- * Which means that you should register your handler with sigaction, using the
- * SA_SIGINFO flag, and pass all the arguments you received to
- * xeno_sigwinch_handler.
+ * Which means that you should register your handler with sigaction,
+ * using the SA_SIGINFO flag, and pass all the arguments you received
+ * to xeno_sigwinch_handler.
*/
static inline int pthread_create(pthread_t *tid, const pthread_attr_t * attr)
{
diff --git a/kernel/cobalt/timer.c b/kernel/cobalt/timer.c
index 7e76003..f9028ba 100644
--- a/kernel/cobalt/timer.c
+++ b/kernel/cobalt/timer.c
@@ -17,7 +17,7 @@
*/
/**
- * @addtogroup posix_time
+ * @addtogroup cobalt_time
*
*@{*/
@@ -397,13 +397,14 @@ timer_settime(timer_t timerid, int flags,
/**
* Get timer next expiration date and reload value.
*
- * This service stores, at the address @a value, the expiration date (member @a
- * it_value) and reload value (member @a it_interval) of the timer @a
- * timerid. The values are returned as time intervals, and as multiples of the
- * system clock tick duration (see note in section
- * @ref posix_time "Clocks and timers services" for details on the
- * duration of the system clock tick). If the timer was not started, the
- * returned members @a it_value and @a it_interval of @a value are zero.
+ * This service stores, at the address @a value, the expiration date
+ * (member @a it_value) and reload value (member @a it_interval) of
+ * the timer @a timerid. The values are returned as time intervals,
+ * and as multiples of the system clock tick duration (see note in
+ * section @ref cobalt_time "Clocks and timers services" for details
+ * on the duration of the system clock tick). If the timer was not
+ * started, the returned members @a it_value and @a it_interval of @a
+ * value are zero.
*
* @param timerid timer identifier;
*
diff --git a/lib/analogy/range.c b/lib/analogy/range.c
index 266092d..22d8a93 100644
--- a/lib/analogy/range.c
+++ b/lib/analogy/range.c
@@ -232,7 +232,6 @@ int a4l_find_range(a4l_desc_t * dsc,
* convenience routine which performs no conversion, just copy.
*
* @param[in] chan Channel descriptor
- * @param[in] rng Range descriptor
* @param[out] dst Ouput buffer
* @param[in] src Input buffer
* @param[in] cnt Count of transfer to copy
@@ -241,7 +240,7 @@ int a4l_find_range(a4l_desc_t * dsc,
* code:
*
* - -EINVAL is returned if some argument is missing or wrong;
- * chan, rng and the pointers should be checked; check also the
+ * chan, dst and src pointers should be checked; check also the
* kernel log ("dmesg"); WARNING: a4l_fill_desc() should be called
* before using a4l_ultoraw()
*
@@ -442,7 +441,6 @@ int a4l_rawtod(a4l_chinfo_t * chan,
* routine which performs no conversion, just formatting.
*
* @param[in] chan Channel descriptor
- * @param[in] rng Range descriptor
* @param[out] dst Ouput buffer
* @param[in] src Input buffer
* @param[in] cnt Count of transfer to copy
@@ -450,10 +448,10 @@ int a4l_rawtod(a4l_chinfo_t * chan,
* @return the count of copy performed, otherwise a negative error
* code:
*
- * - -EINVAL is returned if some argument is missing or wrong;
- * chan, rng and the pointers should be checked; check also the
- * kernel log ("dmesg"); WARNING: a4l_fill_desc() should be called
- * before using a4l_ultoraw()
+ * - -EINVAL is returned if some argument is missing or wrong; chan,
+ * dst and src pointers should be checked; check also the kernel
+ * log ("dmesg"); WARNING: a4l_fill_desc() should be called before
+ * using a4l_ultoraw()
*
*/
int a4l_ultoraw(a4l_chinfo_t * chan, void *dst, unsigned long *src, int cnt)
diff --git a/lib/analogy/sys.c b/lib/analogy/sys.c
index ac50915..47c2e37 100644
--- a/lib/analogy/sys.c
+++ b/lib/analogy/sys.c
@@ -190,7 +190,7 @@ int a4l_sys_detach(int fd)
*
* @param[in] fd File descriptor as returned by a4l_sys_open()
* @param[in] idx_subd Index of the concerned subdevice
- * @param[int] size Buffer size to be set
+ * @param[in] size Buffer size to be set
*
* @return 0 on success. Otherwise:
*
_______________________________________________
Xenomai-git mailing list
Xenomai-git@gna.org
https://mail.gna.org/listinfo/xenomai-git
