[rtems commit] doxygen: Add group for FreeBSD kernel header files

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    3353d3f3ad7ccb9256e39d0a5c29b6b917967cf0
Changeset: http://git.rtems.org/rtems/commit/?id=3353d3f3ad7ccb9256e39d0a5c29b6b917967cf0

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Mar 16 14:07:52 2023 +0100

doxygen: Add group for FreeBSD kernel header files

---

 cpukit/doxygen/top-level-groups.h       | 9 +++++++++
 cpukit/include/machine/_kernel_cpuset.h | 2 ++
 cpukit/include/machine/_kernel_in.h     | 2 ++
 cpukit/include/machine/_kernel_in6.h    | 2 ++
 cpukit/include/machine/_kernel_mman.h   | 2 ++
 cpukit/include/machine/_kernel_param.h  | 2 ++
 cpukit/include/machine/_kernel_time.h   | 2 ++
 cpukit/include/machine/_kernel_types.h  | 2 ++
 cpukit/include/machine/_kernel_uio.h    | 2 ++
 9 files changed, 25 insertions(+)

diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
index 91a55eef65..b5dd3e22e2 100644
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -58,6 +58,15 @@
  * @ingroup RTEMSImpl
  */
 
+/**
+ * @defgroup RTEMSImplFreeBSDKernel FreeBSD Kernel Space Support
+ *
+ * @ingroup RTEMSImpl
+ *
+ * @brief This group contains the interfaces used by FreeBSD kernel space
+ *   components ported to RTEMS.
+ */
+
 /**
  * @defgroup RTEMSTestSuites Test Suites
  *
diff --git a/cpukit/include/machine/_kernel_cpuset.h b/cpukit/include/machine/_kernel_cpuset.h
index 19c1a3e504..e005792b81 100644
--- a/cpukit/include/machine/_kernel_cpuset.h
+++ b/cpukit/include/machine/_kernel_cpuset.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides CPU set definitions for the kernel space
  *   (_KERNEL is defined before including <sys/cpuset.h>).
  */
diff --git a/cpukit/include/machine/_kernel_in.h b/cpukit/include/machine/_kernel_in.h
index 78492453cd..1c7ad25565 100644
--- a/cpukit/include/machine/_kernel_in.h
+++ b/cpukit/include/machine/_kernel_in.h
@@ -35,6 +35,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides IPv4 definitions for the kernel space
  *   (_KERNEL is defined before including <netinet/in.h>).
  */
diff --git a/cpukit/include/machine/_kernel_in6.h b/cpukit/include/machine/_kernel_in6.h
index 857b51548d..e198e5d37a 100644
--- a/cpukit/include/machine/_kernel_in6.h
+++ b/cpukit/include/machine/_kernel_in6.h
@@ -34,6 +34,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides IPv6 definitions for the kernel space
  *   (_KERNEL is defined before including <netinet6/in6.h>).
  */
diff --git a/cpukit/include/machine/_kernel_mman.h b/cpukit/include/machine/_kernel_mman.h
index fa2677a122..57a0482d65 100644
--- a/cpukit/include/machine/_kernel_mman.h
+++ b/cpukit/include/machine/_kernel_mman.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides memory map definitions for the kernel space
  *   (_KERNEL is defined before including <sys/mman.h>).
  */
diff --git a/cpukit/include/machine/_kernel_param.h b/cpukit/include/machine/_kernel_param.h
index 1235d7b324..5100382ef5 100644
--- a/cpukit/include/machine/_kernel_param.h
+++ b/cpukit/include/machine/_kernel_param.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides parameter definitions for the kernel space
  *   (_KERNEL is defined before including <sys/param.h>).
  */
diff --git a/cpukit/include/machine/_kernel_time.h b/cpukit/include/machine/_kernel_time.h
index c65355d006..91df51b69a 100644
--- a/cpukit/include/machine/_kernel_time.h
+++ b/cpukit/include/machine/_kernel_time.h
@@ -37,6 +37,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides time definitions for the kernel space
  *   (_KERNEL is defined before including <sys/time.h>).
  */
diff --git a/cpukit/include/machine/_kernel_types.h b/cpukit/include/machine/_kernel_types.h
index 7f70964e2d..b9f576255c 100644
--- a/cpukit/include/machine/_kernel_types.h
+++ b/cpukit/include/machine/_kernel_types.h
@@ -3,6 +3,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides type definitions for the kernel space
  *   (_KERNEL is defined before including <sys/types.h>).
  */
diff --git a/cpukit/include/machine/_kernel_uio.h b/cpukit/include/machine/_kernel_uio.h
index c9454e97ca..8e368770f1 100644
--- a/cpukit/include/machine/_kernel_uio.h
+++ b/cpukit/include/machine/_kernel_uio.h
@@ -35,6 +35,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSImplFreeBSDKernel
+ *
  * @brief This header file provides device driver I/O definitions for the
  *   kernel space (_KERNEL is defined before including <sys/uio.h>).
  */