Commit 0befd52e authored by Philippe Gerum's avatar Philippe Gerum Committed by Jan Kiszka

doc: fix assorted Doxygen warnings

WARN_IF_UNDOCUMENTED is switched to "NO" to prevent a truckload of
useless warnings from Doxygen since most ioctl calls are not
documented.
Signed-off-by: Philippe Gerum's avatarPhilippe Gerum <rpm@xenomai.org>
Signed-off-by: Jan Kiszka's avatarJan Kiszka <jan.kiszka@siemens.com>
parent 167f2989
......@@ -131,9 +131,9 @@ TAB_SIZE = 8
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = \
"coretags{1}=@par Tags\n@ref cobalt-core-tags \"\1\"" \
"apitags{1}=@par Tags\n@ref api-tags \"\1\"" \
"sideeffect=@par Side effects\n"
"coretags{1}=@par Tags^^@ref cobalt-core-tags \"\1\"" \
"apitags{1}=@par Tags^^@ref api-tags \"\1\"" \
"sideeffect=@par Side effects^^"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C.
......@@ -316,7 +316,7 @@ WARNINGS = YES
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = NO
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
......@@ -710,11 +710,6 @@ ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
......
......@@ -89,8 +89,6 @@ struct a4l_subdevice {
/**< Private data */
};
/*! @} subdevice */
/* --- Subdevice related functions and macros --- */
struct a4l_channel *a4l_get_chfeat(struct a4l_subdevice * sb, int idx);
......
......@@ -210,7 +210,7 @@ static inline struct rtdm_device *rtdm_fd_device(struct rtdm_fd *fd)
* This descriptor details the profile information associated to a
* RTDM class of device managed by a driver.
*
* @anchor rtdm_profile_info @name RTDM profile information descriptor
* @anchor rtdm_profile_info
*/
struct rtdm_profile_info {
/** Device class name */
......@@ -218,7 +218,7 @@ struct rtdm_profile_info {
/** Device class ID, see @ref RTDM_CLASS_xxx */
int class_id;
/** Device sub-class, see RTDM_SUBCLASS_xxx definition in the
* @ref rtdm_profiles "Device Profiles" */
@ref rtdm_profiles "Device Profiles" */
int subclass_id;
/** Supported device profile version */
int version;
......@@ -389,8 +389,6 @@ struct rtdm_device {
};
};
/** @} devregister */
/* --- device registration --- */
int rtdm_dev_register(struct rtdm_device *device);
......
......@@ -22,7 +22,7 @@
#include <cobalt/kernel/clock.h>
/*
/**
* @ingroup cobalt_core_thread
* @defgroup cobalt_core_stat Thread runtime statistics
* @{
......
......@@ -502,8 +502,6 @@ static inline void xntimer_dequeue(struct xntimer *timer,
timer->status |= XNTIMER_DEQUEUED;
}
/** @} */
unsigned long long xntimer_get_overruns(struct xntimer *timer,
struct xnthread *waiter,
xnticks_t now);
......
......@@ -466,9 +466,9 @@ struct can_ifreq {
* @anchor CANIOCTLs @name IOCTLs
* CAN device IOCTLs
*
* @deprecated Passing <TT>struct ifreq<TT> as a request descriptor
* @deprecated Passing \c struct \c ifreq as a request descriptor
* for CAN IOCTLs is still accepted for backward compatibility,
* however it is recommended to switch to <TT>struct can_ifreq<TT> at
* however it is recommended to switch to \c struct \c can_ifreq at
* the first opportunity.
*
* @{ */
......
......@@ -646,4 +646,4 @@ void rtdm_cleanup(void)
*/
}
/*@}*/
/** @} */
......@@ -601,6 +601,9 @@ void xntimer_release_ipi(void)
*
* @param timer The address of a valid timer descriptor.
*
* @param waiter The thread for which the overrun count is being
* collected.
*
* @param now current date (as
* xnclock_read_raw(xntimer_clock(timer)))
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment