Doxygen: Adding Doxygen groups to filesqual-50

23 files changed, 225 insertions, 0 deletions

diff --git a/cpukit/include/machine/_kernel_cpuset.h b/cpukit/include/machine/_kernel_cpuset.h
index e69de29bb2..e9cc78cdd1 100644
--- a/cpukit/include/machine/_kernel_cpuset.h
+++ b/cpukit/include/machine/_kernel_cpuset.h
@@ -0,0 +1,8 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplKernel
+ *
+ * @brief This header file provides interfaces of the
+ *   kernel functions.
+ */
diff --git a/cpukit/include/machine/_kernel_param.h b/cpukit/include/machine/_kernel_param.h
index 183bb895a2..103db927f3 100644
--- a/cpukit/include/machine/_kernel_param.h
+++ b/cpukit/include/machine/_kernel_param.h
@@ -1,3 +1,18 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplKernel
+ *
+ * @brief This header file provides interfaces of the
+ *   kernel functions.
+ */
+
+/**
+ * @defgroup RTEMSImplKernel RTEMS Kernel Interface
+ *
+ * @ingroup RTEMSImpl
+ */
+
 #include <sys/cdefs.h>
 #include <sys/errno.h>
 #include <sys/time.h>
diff --git a/cpukit/include/machine/_kernel_time.h b/cpukit/include/machine/_kernel_time.h
index f0b6bdfc47..b96db23690 100644
--- a/cpukit/include/machine/_kernel_time.h
+++ b/cpukit/include/machine/_kernel_time.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplKernel
+ *
+ * @brief This header file provides interfaces of the
+ *   kernel functions.
+ */
+
 /*-
  * Copyright (c) 2016 embedded brains GmbH
  * All rights reserved.
diff --git a/cpukit/include/machine/_kernel_types.h b/cpukit/include/machine/_kernel_types.h
index a02f328aa2..d17be5e846 100644
--- a/cpukit/include/machine/_kernel_types.h
+++ b/cpukit/include/machine/_kernel_types.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplKernel
+ *
+ * @brief This header file provides interfaces of the
+ *   kernel functions.
+ */
+
 /*-
  * Copyright (c) 2016 embedded brains GmbH
  * All rights reserved.
diff --git a/cpukit/include/machine/_timecounter.h b/cpukit/include/machine/_timecounter.h
index fb974f13c1..9934c3ab7b 100644
--- a/cpukit/include/machine/_timecounter.h
+++ b/cpukit/include/machine/_timecounter.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreTimecounter
+ *
+ * @brief This header file provides interfaces of the
+ *   machine timecounter functions.
+ */
+
 /*-
  * Copyright (c) 2016 embedded brains GmbH
  * All rights reserved.
diff --git a/cpukit/include/rtems/linkersets.h b/cpukit/include/rtems/linkersets.h
index e156fd4379..cb482e6f1a 100644
--- a/cpukit/include/rtems/linkersets.h
+++ b/cpukit/include/rtems/linkersets.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplLinker
+ *
+ * @brief This header file provides interfaces of the
+ *   linker set support.
+ */
+
 /*
  * Copyright (c) 2015, 2020 embedded brains GmbH.  All rights reserved.
  *
@@ -12,6 +21,12 @@
  * http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @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 8d30ee21e5..a39f4ebc02 100644
--- a/cpukit/include/rtems/posix/posixapi.h
+++ b/cpukit/include/rtems/posix/posixapi.h
@@ -1,6 +1,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 d28e0391fc..c89b74ed82 100644
--- a/cpukit/include/rtems/posix/spinlockimpl.h
+++ b/cpukit/include/rtems/posix/spinlockimpl.h
@@ -1,5 +1,7 @@
 /**
  * @file
+ *
+ * @ingroup RTEMSPOSIXAPISpinlock
  * 
  * @brief Inlined Routines from the POSIX Spinlock Manager
  *
@@ -18,6 +20,12 @@
  *  http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @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 78d5c6cc60..66c903f7e8 100644
--- a/cpukit/include/rtems/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -3,10 +3,18 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplDoxygen
+ *
  * @brief This file exists to provide a top level description of RTEMS for
  *   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 76d84fd787..e1647a951d 100644
--- a/cpukit/include/rtems/scheduler.h
+++ b/cpukit/include/rtems/scheduler.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSApplConfigGeneralSchedulerConfiguration
+ *
  * @brief Scheduler Configuration API
  */
 
diff --git a/cpukit/include/rtems/sysinit.h b/cpukit/include/rtems/sysinit.h
index e3d70230c7..ca67f739db 100644
--- a/cpukit/include/rtems/sysinit.h
+++ b/cpukit/include/rtems/sysinit.h
@@ -1,3 +1,12 @@
+/**
+ * @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 c4b6041403..c6ebf73abe 100644
--- a/cpukit/include/rtems/test-info.h
+++ b/cpukit/include/rtems/test-info.h
@@ -1,3 +1,12 @@
+/**
+ * @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 305fe3f5f3..46801bdab4 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 4988b46faa..75361f8771 100644
--- a/cpukit/include/rtems/thread.h
+++ b/cpukit/include/rtems/thread.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplThread
+ *
+ * @brief This header file provides interfaces of the
+ *   Thread Handler.
+ */
+
 /*
  * Copyright (c) 2017 embedded brains GmbH.  All rights reserved.
  *
@@ -12,6 +21,12 @@
  * http://www.rtems.org/license/LICENSE.
  */
 
+/**
+ * @defgroup RTEMSImplThread Thread Handler
+ *
+ * @ingroup RTEMSImpl
+ */
+
 #ifndef _RTEMS_THREAD_H
 #define _RTEMS_THREAD_H
 
diff --git a/cpukit/include/sha256.h b/cpukit/include/sha256.h
index 1b6a4f4c57..57767a4627 100644
--- a/cpukit/include/sha256.h
+++ b/cpukit/include/sha256.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSHA256
+ *
+ * @brief This header file provides interfaces of the
+ *   SHA256 Checksum Implementation.
+ */
+
 /*-
  * Copyright 2005 Colin Percival
  * All rights reserved.
@@ -26,6 +35,12 @@
  * $FreeBSD$
  */
 
+/**
+ * @defgroup RTEMSImplSHA256 SHA256 Checksum Implementation
+ *
+ * @ingroup RTEMSImpl
+ */
+
 #ifndef _SHA256_H_
 #define _SHA256_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..c785879911 100644
--- a/cpukit/include/sys/priority.h
+++ b/cpukit/include/sys/priority.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup POSIX_PRIORITY
+ *
+ * @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 e065a1b46e..f9f5183daf 100644
--- a/cpukit/include/sys/statvfs.h
+++ b/cpukit/include/sys/statvfs.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSAPIStatvfs
+ *
  * @brief Interface to the statvfs() Set of API Methods
  *
  * This include file defines the interface to the statvfs() set of
@@ -20,6 +22,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 01212f0b43..c88d676799 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 5cdfdfe9b3..2894fc8893 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 d2d2012ff5..6339bc5cd1 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