summaryrefslogtreecommitdiff
path: root/cpukit/include
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include')
-rw-r--r--cpukit/include/machine/_timecounter.h2
-rw-r--r--cpukit/include/rtems/linkersets.h15
-rw-r--r--cpukit/include/rtems/posix/posixapi.h2
-rw-r--r--cpukit/include/rtems/posix/spinlockimpl.h8
-rw-r--r--cpukit/include/rtems/rtems/mainpage.h6
-rw-r--r--cpukit/include/rtems/scheduler.h2
-rw-r--r--cpukit/include/rtems/sysinit.h9
-rw-r--r--cpukit/include/rtems/test-info.h9
-rw-r--r--cpukit/include/rtems/test.h9
-rw-r--r--cpukit/include/rtems/thread.h15
-rw-r--r--cpukit/include/sys/_ffcounter.h9
-rw-r--r--cpukit/include/sys/endian.h15
-rw-r--r--cpukit/include/sys/priority.h9
-rw-r--r--cpukit/include/sys/statvfs.h8
-rw-r--r--cpukit/include/sys/timeffc.h9
-rw-r--r--cpukit/include/sys/timepps.h9
-rw-r--r--cpukit/include/sys/timetc.h9
-rw-r--r--cpukit/include/sys/timex.h15
18 files changed, 160 insertions, 0 deletions
diff --git a/cpukit/include/machine/_timecounter.h b/cpukit/include/machine/_timecounter.h
index fc3d78c5ad..28f84336da 100644
--- a/cpukit/include/machine/_timecounter.h
+++ b/cpukit/include/machine/_timecounter.h
@@ -3,6 +3,8 @@
/**
* @file
*
+ * @ingroup RTEMSScoreTimecounter
+ *
* @brief This header file provides timecounter definitions for the kernel space
* (_KERNEL is defined before including <sys/time.h>) and RTEMS.
*/
diff --git a/cpukit/include/rtems/linkersets.h b/cpukit/include/rtems/linkersets.h
index c4b3e2b7dc..f81876d399 100644
--- a/cpukit/include/rtems/linkersets.h
+++ b/cpukit/include/rtems/linkersets.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplLinker
+ *
+ * @brief This header file provides interfaces of the
+ * linker set support.
+ */
+
/*
* Copyright (c) 2015, 2020 embedded brains GmbH. All rights reserved.
*
@@ -25,6 +34,12 @@
* POSSIBILITY OF SUCH DAMAGE.
*/
+/**
+ * @defgroup RTEMSImplLinker RTEMS linker control
+ *
+ * @ingroup RTEMSImpl
+ */
+
#ifndef _RTEMS_LINKERSET_H
#define _RTEMS_LINKERSET_H
diff --git a/cpukit/include/rtems/posix/posixapi.h b/cpukit/include/rtems/posix/posixapi.h
index 24c1dc51e0..bb966920dc 100644
--- a/cpukit/include/rtems/posix/posixapi.h
+++ b/cpukit/include/rtems/posix/posixapi.h
@@ -3,6 +3,8 @@
/**
* @file
*
+ * @ingroup POSIXAPI
+ *
* @brief POSIX API Implementation
*
* This include file defines the top level interface to the POSIX API
diff --git a/cpukit/include/rtems/posix/spinlockimpl.h b/cpukit/include/rtems/posix/spinlockimpl.h
index a5e5bb1850..599ed88ca3 100644
--- a/cpukit/include/rtems/posix/spinlockimpl.h
+++ b/cpukit/include/rtems/posix/spinlockimpl.h
@@ -2,6 +2,8 @@
/**
* @file
+ *
+ * @ingroup RTEMSPOSIXAPISpinlock
*
* @brief Inlined Routines from the POSIX Spinlock Manager
*
@@ -37,6 +39,12 @@
* POSSIBILITY OF SUCH DAMAGE.
*/
+/**
+ * @defgroup RTEMSPOSIXAPISpinlock POSIX Spinlock Manager
+ *
+ * @ingroup POSIXAPI
+ */
+
#ifndef _RTEMS_POSIX_SPINLOCKIMPL_H
#define _RTEMS_POSIX_SPINLOCKIMPL_H
diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h
index deb9636411..66c903f7e8 100644
--- a/cpukit/include/rtems/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -9,6 +9,12 @@
* Doxygen.
*/
+/**
+ * @defgroup RTEMSImplDoxygen Doxygen document generator support
+ *
+ * @ingroup RTEMSImpl
+ */
+
/*
* Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
*
diff --git a/cpukit/include/rtems/scheduler.h b/cpukit/include/rtems/scheduler.h
index a8004cb5e4..80e5d39f66 100644
--- a/cpukit/include/rtems/scheduler.h
+++ b/cpukit/include/rtems/scheduler.h
@@ -3,6 +3,8 @@
/**
* @file
*
+ * @ingroup RTEMSApplConfigGeneralSchedulerConfiguration
+ *
* @brief Scheduler Configuration API
*/
diff --git a/cpukit/include/rtems/sysinit.h b/cpukit/include/rtems/sysinit.h
index ad483684e7..f8395c3745 100644
--- a/cpukit/include/rtems/sysinit.h
+++ b/cpukit/include/rtems/sysinit.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSAPIClassicInit
+ *
+ * @brief This header file provides interfaces of the
+ * system initialization handler.
+ */
+
/*
* Copyright (c) 2015, 2020 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/include/rtems/test-info.h b/cpukit/include/rtems/test-info.h
index 3b839533c2..3f818eca49 100644
--- a/cpukit/include/rtems/test-info.h
+++ b/cpukit/include/rtems/test-info.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This header file provides interfaces of the
+ * RTEMS Test Framework.
+ */
+
/*
* Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/include/rtems/test.h b/cpukit/include/rtems/test.h
index 0eb2c37b67..414363065c 100644
--- a/cpukit/include/rtems/test.h
+++ b/cpukit/include/rtems/test.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This header file provides interfaces of the
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/include/rtems/thread.h b/cpukit/include/rtems/thread.h
index f77b572e34..164f4b388a 100644
--- a/cpukit/include/rtems/thread.h
+++ b/cpukit/include/rtems/thread.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplThread
+ *
+ * @brief This header file provides interfaces of the
+ * Thread Handler.
+ */
+
/*
* Copyright (c) 2017 embedded brains GmbH. All rights reserved.
*
@@ -25,6 +34,12 @@
* POSSIBILITY OF SUCH DAMAGE.
*/
+/**
+ * @defgroup RTEMSImplThread Thread Handler
+ *
+ * @ingroup RTEMSImpl
+ */
+
#ifndef _RTEMS_THREAD_H
#define _RTEMS_THREAD_H
diff --git a/cpukit/include/sys/_ffcounter.h b/cpukit/include/sys/_ffcounter.h
index d83c48cd44..c9cb9f6cda 100644
--- a/cpukit/include/sys/_ffcounter.h
+++ b/cpukit/include/sys/_ffcounter.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysTimer
+ *
+ * @brief This header file provides interfaces of the
+ * feed-forward clock counter.
+ */
+
/*-
* Copyright (c) 2011 The University of Melbourne
* All rights reserved.
diff --git a/cpukit/include/sys/endian.h b/cpukit/include/sys/endian.h
index 0849a6a90b..d0037f2984 100644
--- a/cpukit/include/sys/endian.h
+++ b/cpukit/include/sys/endian.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysEndian
+ *
+ * @brief This header file provides interfaces of the
+ * system endianness.
+ */
+
/*-
* Copyright (c) 2002 Thomas Moestl <tmm@FreeBSD.org>
* All rights reserved.
@@ -26,6 +35,12 @@
* $FreeBSD: head/sys/sys/endian.h 208331 2010-05-20 06:16:13Z phk $
*/
+/**
+ * @defgroup RTEMSImplSysEndian System Endianness Support
+ *
+ * @ingroup RTEMSImpl
+ */
+
#ifndef _SYS_ENDIAN_H_
#define _SYS_ENDIAN_H_
diff --git a/cpukit/include/sys/priority.h b/cpukit/include/sys/priority.h
index 855edb63c2..1ca2e35d7b 100644
--- a/cpukit/include/sys/priority.h
+++ b/cpukit/include/sys/priority.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplKernel
+ *
+ * @brief This header file provides interfaces of the
+ * Process priority specifications.
+ */
+
/*-
* SPDX-License-Identifier: BSD-4-Clause
*
diff --git a/cpukit/include/sys/statvfs.h b/cpukit/include/sys/statvfs.h
index 52d8e9d3fa..062d66ce02 100644
--- a/cpukit/include/sys/statvfs.h
+++ b/cpukit/include/sys/statvfs.h
@@ -3,6 +3,8 @@
/**
* @file
*
+ * @ingroup RTEMSAPIStatvfs
+ *
* @brief Interface to the statvfs() Set of API Methods
*
* This include file defines the interface to the statvfs() set of
@@ -39,6 +41,12 @@
/*
*/
+/**
+ * @defgroup RTEMSAPIStatvfs statvfs API Methods
+ *
+ * @ingroup RTEMSAPI
+ */
+
#ifndef _SYS_STATVFS_H_
#define _SYS_STATVFS_H_
diff --git a/cpukit/include/sys/timeffc.h b/cpukit/include/sys/timeffc.h
index c04de97f1d..ac66791012 100644
--- a/cpukit/include/sys/timeffc.h
+++ b/cpukit/include/sys/timeffc.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysTimer
+ *
+ * @brief This header file provides interfaces of the
+ * feed-forward clock counter.
+ */
+
/*-
* Copyright (c) 2011 The University of Melbourne
* All rights reserved.
diff --git a/cpukit/include/sys/timepps.h b/cpukit/include/sys/timepps.h
index 030c734477..96b695d907 100644
--- a/cpukit/include/sys/timepps.h
+++ b/cpukit/include/sys/timepps.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysTimer
+ *
+ * @brief This header file provides interfaces of the
+ * Pulse Per Second timing.
+ */
+
/*-
* ----------------------------------------------------------------------------
* "THE BEER-WARE LICENSE" (Revision 42):
diff --git a/cpukit/include/sys/timetc.h b/cpukit/include/sys/timetc.h
index 1ef58b378d..551fc998e5 100644
--- a/cpukit/include/sys/timetc.h
+++ b/cpukit/include/sys/timetc.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysTimer
+ *
+ * @brief This header file provides interfaces of the
+ * binary timecounter.
+ */
+
/*-
* ----------------------------------------------------------------------------
* "THE BEER-WARE LICENSE" (Revision 42):
diff --git a/cpukit/include/sys/timex.h b/cpukit/include/sys/timex.h
index 8e763bb30f..049b29c998 100644
--- a/cpukit/include/sys/timex.h
+++ b/cpukit/include/sys/timex.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysTimer
+ *
+ * @brief This header file provides interfaces of the
+ * Network Time Protocol (NTP)
+ */
+
/*-
***********************************************************************
* *
@@ -32,6 +41,12 @@
*
*/
+/**
+ * @defgroup RTEMSImplSysTimer System Timer Support
+ *
+ * @ingroup RTEMSImpl
+ */
+
#ifndef _SYS_TIMEX_H_
#define _SYS_TIMEX_H_ 1
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-02 23:19:01 +0000