[rtems commit] doxygen: Added further groups to RTEMSAPI
Sebastian Huber
sebh at rtems.org
Thu Apr 4 06:27:36 UTC 2019
Module: rtems
Branch: master
Commit: b7927efc5a02275beffb0205fc514637b39391b1
Changeset: http://git.rtems.org/rtems/commit/?id=b7927efc5a02275beffb0205fc514637b39391b1
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Tue Apr 2 12:06:30 2019 +0200
doxygen: Added further groups to RTEMSAPI
Update #3706.
Associativity Routines, BSD Compatibility Support now part of
RTEMSAPI
---
cpukit/include/rtems/assoc.h | 25 ++++++++++++++++---------
cpukit/include/rtems/bsd.h | 6 ++++--
2 files changed, 20 insertions(+), 11 deletions(-)
diff --git a/cpukit/include/rtems/assoc.h b/cpukit/include/rtems/assoc.h
index 97e5001..78cbdf6 100644
--- a/cpukit/include/rtems/assoc.h
+++ b/cpukit/include/rtems/assoc.h
@@ -1,21 +1,15 @@
/**
* @file
*
- * @brief RTEMS Associativity Routines
+ * @ingroup RTEMSAPIAssociativity
*
- * RTEMS associativity routines. Mainly used to convert a value from
- * one space to another (eg: our errno's to host errno's and vice-versa)
+ * @brief RTEMS Associativity Routines
*/
#ifndef _RTEMS_RTEMS_ASSOC_H
#define _RTEMS_RTEMS_ASSOC_H
-/**
- * @defgroup Associativity Associativity Routines
- */
-/**@{*/
-
#include <stddef.h>
#include <stdint.h>
@@ -23,6 +17,17 @@
extern "C" {
#endif
+/**
+ * @defgroup RTEMSAPIAssociativity Associativity Routines
+ *
+ * @ingroup RTEMSAPI
+ *
+ * RTEMS associativity routines. Mainly used to convert a value from
+ * one space to another (eg: our errno's to host errno's and vice-versa)
+ *
+ * @{
+ */
+
typedef struct {
const char *name;
uint32_t local_value;
@@ -197,8 +202,10 @@ size_t rtems_assoc_thread_states_to_string(
size_t buffer_size
);
+/** @} */
+
#ifdef __cplusplus
}
#endif
-/**@}*/
+
#endif /* ! _RTEMS_RTEMS_ASSOC_H */
diff --git a/cpukit/include/rtems/bsd.h b/cpukit/include/rtems/bsd.h
index 0c44e37..8f85288 100644
--- a/cpukit/include/rtems/bsd.h
+++ b/cpukit/include/rtems/bsd.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup BSD
+ * @ingroup RTEMSAPIBSD
*
* @brief BSD Compatibility API
*/
@@ -31,7 +31,9 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup BSD BSD Compatibility Support
+ * @defgroup RTEMSAPIBSD BSD Compatibility Support
+ *
+ * @ingroup RTEMSAPI
*
* @{
*/
More information about the vc
mailing list