summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank Kühndel <frank.kuehndel@embedded-brains.de>2021-12-03 23:17:49 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-04-11 08:11:06 +0200
commit6fc21a76ab0471acbf395183ed998edfd5fa7826 (patch)
treeef56b9962ce226d719dd1a3b4d8e42e114ed916f
parentb24cf97f7e1bf33c299efa426361f3f8cc667cc9 (diff)
Doxygen: Adding Doxygen groups to filesqual-57
-rw-r--r--bsps/include/bsp/fatal.h15
-rw-r--r--bsps/shared/cache/cacheimpl.h9
-rw-r--r--bsps/shared/doxygen.h8
-rw-r--r--bsps/shared/rtems-version.c9
-rw-r--r--bsps/sparc/include/bsp/gnatcommon.h15
-rw-r--r--bsps/sparc/include/bsp/gr_leon4_n2x.h9
-rw-r--r--bsps/sparc/include/drvmgr/leon2_amba_bus.h9
-rw-r--r--bsps/sparc/leon3/clock/ckinit.c9
-rw-r--r--bsps/sparc/leon3/console/printk_support.c9
-rw-r--r--bsps/sparc/leon3/start/bspstart.c9
-rw-r--r--bsps/sparc/leon3/start/cache.c9
-rw-r--r--bsps/sparc/leon3/start/cpucounter.c9
-rw-r--r--bsps/sparc/leon3/start/eirq.c9
-rw-r--r--bsps/sparc/shared/doxygen.h8
-rw-r--r--bsps/sparc/shared/irq/bsp_isr_handler.c9
-rw-r--r--cpukit/doxygen.h8
-rw-r--r--cpukit/doxygen/appl-config.h9
-rw-r--r--cpukit/doxygen/top-level-groups.h8
-rw-r--r--cpukit/include/machine/_kernel_cpuset.h8
-rw-r--r--cpukit/include/machine/_kernel_param.h15
-rw-r--r--cpukit/include/machine/_kernel_time.h9
-rw-r--r--cpukit/include/machine/_kernel_types.h9
-rw-r--r--cpukit/include/machine/_timecounter.h9
-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.h8
-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/sha256.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
-rw-r--r--cpukit/libc/search/qsort.c9
-rw-r--r--cpukit/libc/string/flsl.c9
-rw-r--r--cpukit/libc/string/local.h9
-rw-r--r--cpukit/libc/string/memcmp.c9
-rw-r--r--cpukit/libc/string/memcpy.c9
-rw-r--r--cpukit/libc/string/memset.c9
-rw-r--r--cpukit/libc/string/strchr.c9
-rw-r--r--cpukit/libc/string/strcmp.c9
-rw-r--r--cpukit/libc/string/strlen.c9
-rw-r--r--cpukit/libc/string/strrchr.c9
-rw-r--r--cpukit/libcsupport/src/malloc_p.h9
-rw-r--r--cpukit/libmd/sha256c.c9
-rw-r--r--cpukit/libmisc/cpuuse/cpuuseimpl.h9
-rw-r--r--cpukit/libtest/t-test-checks.c9
-rw-r--r--cpukit/libtest/t-test-hash-sha256.c9
-rw-r--r--cpukit/libtest/t-test-rtems-context.c9
-rw-r--r--cpukit/libtest/t-test-rtems-measure.c9
-rw-r--r--cpukit/libtest/t-test-rtems-memory.c9
-rw-r--r--cpukit/libtest/t-test-rtems.c9
-rw-r--r--cpukit/libtest/t-test-time.c9
-rw-r--r--cpukit/libtest/t-test.c9
-rw-r--r--cpukit/libtest/testbeginend.c9
-rw-r--r--cpukit/sapi/src/cpucounterconverter.c9
-rw-r--r--cpukit/score/cpu/no_cpu/cpuidle.c9
-rw-r--r--cpukit/score/cpu/sparc/include/libcpu/grlib-tn-0018.h9
-rw-r--r--cpukit/score/cpu/sparc/include/rtems/asm.h2
-rw-r--r--cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h10
-rw-r--r--cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h9
-rw-r--r--cpukit/score/cpu/sparc/syscall.h15
-rw-r--r--cpukit/score/src/stackallocatorforidle.c9
71 files changed, 665 insertions, 0 deletions
diff --git a/bsps/include/bsp/fatal.h b/bsps/include/bsp/fatal.h
index 3430effb18..983cef2f9c 100644
--- a/bsps/include/bsp/fatal.h
+++ b/bsps/include/bsp/fatal.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsFatal
+ *
+ * @brief This header file provides interfaces of the
+ * BSP fatal codes.
+ */
+
/*
* Copyright (c) 2012, 2018 embedded brains GmbH. All rights reserved.
*
@@ -6,6 +15,12 @@
* http://www.rtems.org/license/LICENSE.
*/
+/**
+ * @defgroup RTEMSBSPsFatal BSP fatal codes
+ *
+ * @ingroup RTEMSBSPs
+ */
+
#ifndef LIBBSP_SHARED_BSP_FATAL_H
#define LIBBSP_SHARED_BSP_FATAL_H
diff --git a/bsps/shared/cache/cacheimpl.h b/bsps/shared/cache/cacheimpl.h
index 16fe59d804..3783cd2aa3 100644
--- a/bsps/shared/cache/cacheimpl.h
+++ b/bsps/shared/cache/cacheimpl.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup CACHE_MGR
+ *
+ * @brief This header file provides interfaces of the
+ * RTEMS Cache Manager.
+ */
+
/*
* Cache Manager
*
diff --git a/bsps/shared/doxygen.h b/bsps/shared/doxygen.h
index d3679c2f3d..fa16512d45 100644
--- a/bsps/shared/doxygen.h
+++ b/bsps/shared/doxygen.h
@@ -1,4 +1,12 @@
/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines Doxygen groups.
+ */
+
+/**
* @defgroup RTEMSBSPs Board Support Packages
*
* @brief This group contains the Board Support Packages (BSPs).
diff --git a/bsps/shared/rtems-version.c b/bsps/shared/rtems-version.c
index b12504a1c9..258f420dec 100644
--- a/bsps/shared/rtems-version.c
+++ b/bsps/shared/rtems-version.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSAPIClassicVersion
+ *
+ * @brief This header file provides interfaces of the
+ * RTEMS versions.
+ */
+
/*
* COPYRIGHT (c) 2003, Ralf Corsepius, Ulm, Germany.
* COPYRIGHT (c) 2003, On-Line Applications Research Corporation (OAR).
diff --git a/bsps/sparc/include/bsp/gnatcommon.h b/bsps/sparc/include/bsp/gnatcommon.h
index 1a04449293..40e8829bb9 100644
--- a/bsps/sparc/include/bsp/gnatcommon.h
+++ b/bsps/sparc/include/bsp/gnatcommon.h
@@ -1,3 +1,18 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplGnat
+ *
+ * @brief This header file provides interfaces of the
+ * gnat/rtems interrupts and exception handling.
+ */
+
+/**
+ * @defgroup RTEMSImplGnat GNAT/RTEMS interrupts and exception handling
+ *
+ * @ingroup RTEMSImpl
+ */
+
#ifndef __GNATCOMMON_H
#define __GNATCOMMON_H
diff --git a/bsps/sparc/include/bsp/gr_leon4_n2x.h b/bsps/sparc/include/bsp/gr_leon4_n2x.h
index 9a8041202a..7f67d7b297 100644
--- a/bsps/sparc/include/bsp/gr_leon4_n2x.h
+++ b/bsps/sparc/include/bsp/gr_leon4_n2x.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This header file provides interfaces of the
+ * GR-CPCI-LEON4-N2X (NGFP) PCI Peripheral driver
+ */
+
/* GR-CPCI-LEON4-N2X (NGFP) PCI Peripheral driver
*
* COPYRIGHT (c) 2013.
diff --git a/bsps/sparc/include/drvmgr/leon2_amba_bus.h b/bsps/sparc/include/drvmgr/leon2_amba_bus.h
index 1b35413c30..4bf22cc7e1 100644
--- a/bsps/sparc/include/drvmgr/leon2_amba_bus.h
+++ b/bsps/sparc/include/drvmgr/leon2_amba_bus.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON2
+ *
+ * @brief This header file provides interfaces of the
+ * LEON2 Hardcoded bus driver interface.
+ */
+
/* LEON2 Hardcoded bus driver interface.
*
* COPYRIGHT (c) 2008.
diff --git a/bsps/sparc/leon3/clock/ckinit.c b/bsps/sparc/leon3/clock/ckinit.c
index 4f7fa7ab78..17b653571c 100644
--- a/bsps/sparc/leon3/clock/ckinit.c
+++ b/bsps/sparc/leon3/clock/ckinit.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * the Clock Tick Device Driver.
+ */
+
/*
* Clock Tick Device Driver
*
diff --git a/bsps/sparc/leon3/console/printk_support.c b/bsps/sparc/leon3/console/printk_support.c
index b2e9850eb5..7e66627d7d 100644
--- a/bsps/sparc/leon3/console/printk_support.c
+++ b/bsps/sparc/leon3/console/printk_support.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * the TTY driver for the serial ports on the LEON.
+ */
+
/*
* This file contains the TTY driver for the serial ports on the LEON.
*
diff --git a/bsps/sparc/leon3/start/bspstart.c b/bsps/sparc/leon3/start/bspstart.c
index 373121e0ba..373a9ebfca 100644
--- a/bsps/sparc/leon3/start/bspstart.c
+++ b/bsps/sparc/leon3/start/bspstart.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * a set of routines which start the application.
+ */
+
/*
* This set of routines starts the application. It includes application,
* board, and monitor specific initialization and configuration.
diff --git a/bsps/sparc/leon3/start/cache.c b/bsps/sparc/leon3/start/cache.c
index e507e66e7e..8b3b209d92 100644
--- a/bsps/sparc/leon3/start/cache.c
+++ b/bsps/sparc/leon3/start/cache.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * LEON3 CPU cache support.
+ */
+
/*
* Copyright (c) 2014 embedded brains GmbH. All rights reserved.
*
diff --git a/bsps/sparc/leon3/start/cpucounter.c b/bsps/sparc/leon3/start/cpucounter.c
index e20684aa56..b822efb5bb 100644
--- a/bsps/sparc/leon3/start/cpucounter.c
+++ b/bsps/sparc/leon3/start/cpucounter.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * LEON3 CPU counter support.
+ */
+
/*
* Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved.
*
diff --git a/bsps/sparc/leon3/start/eirq.c b/bsps/sparc/leon3/start/eirq.c
index 0dedc66d95..5b8366492b 100644
--- a/bsps/sparc/leon3/start/eirq.c
+++ b/bsps/sparc/leon3/start/eirq.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * the GRLIB/LEON3 extended interrupt controller.
+ */
+
/*
* GRLIB/LEON3 extended interrupt controller
*
diff --git a/bsps/sparc/shared/doxygen.h b/bsps/sparc/shared/doxygen.h
index 100a9b6c18..82e5feb023 100644
--- a/bsps/sparc/shared/doxygen.h
+++ b/bsps/sparc/shared/doxygen.h
@@ -1,4 +1,12 @@
/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines Doxygen groups.
+ */
+
+/**
* @defgroup RTEMSBSPsSPARC SPARC
*
* @ingroup RTEMSBSPs
diff --git a/bsps/sparc/shared/irq/bsp_isr_handler.c b/bsps/sparc/shared/irq/bsp_isr_handler.c
index 1541aa236f..60fa5309ec 100644
--- a/bsps/sparc/shared/irq/bsp_isr_handler.c
+++ b/bsps/sparc/shared/irq/bsp_isr_handler.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains a definition of
+ * ::_SPARC_Interrupt_dispatch.
+ */
+
/*
* COPYRIGHT (c) 2015
* Cobham Gaisler
diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index a60d138c03..30da23e378 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -1,4 +1,12 @@
/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines Doxygen groups.
+ */
+
+/**
* @defgroup RTEMSAPIIO IO
*
* @ingroup RTEMSAPI
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index bb14109a75..346e8feb15 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSApplConfig
+ *
+ * @brief This header file provides interfaces of the
+ * application configuration
+ */
+
/*
* Copyright (C) 2019, 2022 embedded brains GmbH (http://www.embedded-brains.de)
* Copyright (C) 2010 Gedare Bloom
diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
index 8d38195f3e..e563e1a12e 100644
--- a/cpukit/doxygen/top-level-groups.h
+++ b/cpukit/doxygen/top-level-groups.h
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines top level Doxygen groups.
+ */
+
/*
* Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
*
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 cdfcd54cde..ccf7c24c67 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 d166608774..81e0e3d468 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 be3245f90a..4a46e1faf1 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 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 d5c7e51ef5..f421648901 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 1bc963249c..2a38a4f8b5 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 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 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/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..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 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 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
diff --git a/cpukit/libc/search/qsort.c b/cpukit/libc/search/qsort.c
index b53400aa8e..6d93f6fb38 100644
--- a/cpukit/libc/search/qsort.c
+++ b/cpukit/libc/search/qsort.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<qsort>>---sort an array
diff --git a/cpukit/libc/string/flsl.c b/cpukit/libc/string/flsl.c
index af6277d1a4..c4080daf94 100644
--- a/cpukit/libc/string/flsl.c
+++ b/cpukit/libc/string/flsl.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*-
* Copyright (c) 2017 embedded brains GmbH
* All rights reserved.
diff --git a/cpukit/libc/string/local.h b/cpukit/libc/string/local.h
index ef7ba3918f..d160c8018b 100644
--- a/cpukit/libc/string/local.h
+++ b/cpukit/libc/string/local.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This header file provides interfaces of the
+ * C lib.
+ */
+
#include <_ansi.h>
#ifndef __rtems__
#include <../ctype/local.h>
diff --git a/cpukit/libc/string/memcmp.c b/cpukit/libc/string/memcmp.c
index 342fb9fbc8..4169d0fbf1 100644
--- a/cpukit/libc/string/memcmp.c
+++ b/cpukit/libc/string/memcmp.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<memcmp>>---compare two memory areas
diff --git a/cpukit/libc/string/memcpy.c b/cpukit/libc/string/memcpy.c
index 52f716b927..8efb4ba14b 100644
--- a/cpukit/libc/string/memcpy.c
+++ b/cpukit/libc/string/memcpy.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<memcpy>>---copy memory regions
diff --git a/cpukit/libc/string/memset.c b/cpukit/libc/string/memset.c
index a5ea43ea86..f75c527f65 100644
--- a/cpukit/libc/string/memset.c
+++ b/cpukit/libc/string/memset.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<memset>>---set an area of memory
diff --git a/cpukit/libc/string/strchr.c b/cpukit/libc/string/strchr.c
index 96f30be044..1ad6787055 100644
--- a/cpukit/libc/string/strchr.c
+++ b/cpukit/libc/string/strchr.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<strchr>>---search for character in string
diff --git a/cpukit/libc/string/strcmp.c b/cpukit/libc/string/strcmp.c
index 894424a690..07930bdd88 100644
--- a/cpukit/libc/string/strcmp.c
+++ b/cpukit/libc/string/strcmp.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<strcmp>>---character string compare
diff --git a/cpukit/libc/string/strlen.c b/cpukit/libc/string/strlen.c
index acffa49e14..2b50b8e113 100644
--- a/cpukit/libc/string/strlen.c
+++ b/cpukit/libc/string/strlen.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<strlen>>---character string length
diff --git a/cpukit/libc/string/strrchr.c b/cpukit/libc/string/strrchr.c
index 04897e162a..69f7ade6c2 100644
--- a/cpukit/libc/string/strrchr.c
+++ b/cpukit/libc/string/strrchr.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This source file contains a definition of
+ * C lib functions.
+ */
+
/*
FUNCTION
<<strrchr>>---reverse search for character in string
diff --git a/cpukit/libcsupport/src/malloc_p.h b/cpukit/libcsupport/src/malloc_p.h
index 054afd99b2..00be02ce08 100644
--- a/cpukit/libcsupport/src/malloc_p.h
+++ b/cpukit/libcsupport/src/malloc_p.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup libcsupport
+ *
+ * @brief This header file provides interfaces of the
+ * C lib.
+ */
+
/*
* RTEMS Malloc Family Internal Header
*
diff --git a/cpukit/libmd/sha256c.c b/cpukit/libmd/sha256c.c
index 4c0371dda7..628262daf5 100644
--- a/cpukit/libmd/sha256c.c
+++ b/cpukit/libmd/sha256c.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSHA256
+ *
+ * @brief This source file contains a definition of
+ * the SHA256 Checksum Implementation.
+ */
+
/*-
* Copyright 2005 Colin Percival
* All rights reserved.
diff --git a/cpukit/libmisc/cpuuse/cpuuseimpl.h b/cpukit/libmisc/cpuuse/cpuuseimpl.h
index 1162d1e892..b440bcfc88 100644
--- a/cpukit/libmisc/cpuuse/cpuuseimpl.h
+++ b/cpukit/libmisc/cpuuse/cpuuseimpl.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup libmisc_cpuuse
+ *
+ * @brief This header file provides interfaces of the
+ * CPU use accounting.
+ */
+
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libtest/t-test-checks.c b/cpukit/libtest/t-test-checks.c
index c86596521b..ae778e1d68 100644
--- a/cpukit/libtest/t-test-checks.c
+++ b/cpukit/libtest/t-test-checks.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test-hash-sha256.c b/cpukit/libtest/t-test-hash-sha256.c
index 32e946b4cf..1d460be0ba 100644
--- a/cpukit/libtest/t-test-hash-sha256.c
+++ b/cpukit/libtest/t-test-hash-sha256.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test-rtems-context.c b/cpukit/libtest/t-test-rtems-context.c
index cadafcdf94..a16ffd888c 100644
--- a/cpukit/libtest/t-test-rtems-context.c
+++ b/cpukit/libtest/t-test-rtems-context.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test-rtems-measure.c b/cpukit/libtest/t-test-rtems-measure.c
index e21b092a81..2b9da8be86 100644
--- a/cpukit/libtest/t-test-rtems-measure.c
+++ b/cpukit/libtest/t-test-rtems-measure.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test-rtems-memory.c b/cpukit/libtest/t-test-rtems-memory.c
index 92d21a7ccd..1dc90f2cd2 100644
--- a/cpukit/libtest/t-test-rtems-memory.c
+++ b/cpukit/libtest/t-test-rtems-memory.c
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* Copyright (C) 2020 embedded brains GmbH
*
diff --git a/cpukit/libtest/t-test-rtems.c b/cpukit/libtest/t-test-rtems.c
index 71d8057aaf..aa806044a4 100644
--- a/cpukit/libtest/t-test-rtems.c
+++ b/cpukit/libtest/t-test-rtems.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test-time.c b/cpukit/libtest/t-test-time.c
index c6a43acfc5..8e31658cd7 100644
--- a/cpukit/libtest/t-test-time.c
+++ b/cpukit/libtest/t-test-time.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/t-test.c b/cpukit/libtest/t-test.c
index 12d020446a..1bdf079ba0 100644
--- a/cpukit/libtest/t-test.c
+++ b/cpukit/libtest/t-test.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*
diff --git a/cpukit/libtest/testbeginend.c b/cpukit/libtest/testbeginend.c
index f96fdaf6c4..90f370da43 100644
--- a/cpukit/libtest/testbeginend.c
+++ b/cpukit/libtest/testbeginend.c
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This source file contains a definition of
+ * RTEMS Test Framework.
+ */
+
/*
* Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/sapi/src/cpucounterconverter.c b/cpukit/sapi/src/cpucounterconverter.c
index 01499904f9..f83b57b433 100644
--- a/cpukit/sapi/src/cpucounterconverter.c
+++ b/cpukit/sapi/src/cpucounterconverter.c
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSAPICounter
+ *
+ * @brief This source file contains a definition of
+ * the Free-Running Counter and Busy Wait Delay API.
+ */
+
/*
* Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/score/cpu/no_cpu/cpuidle.c b/cpukit/score/cpu/no_cpu/cpuidle.c
index 85ca01b7ca..34636690e1 100644
--- a/cpukit/score/cpu/no_cpu/cpuidle.c
+++ b/cpukit/score/cpu/no_cpu/cpuidle.c
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPU
+ *
+ * @brief This source file contains a definition of
+ * the ::_CPU_Thread_Idle_body.
+ */
+
/*
* Copyright (c) 2013-2014 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/score/cpu/sparc/include/libcpu/grlib-tn-0018.h b/cpukit/score/cpu/sparc/include/libcpu/grlib-tn-0018.h
index 62f33da6e8..f47c8b6859 100644
--- a/cpukit/score/cpu/sparc/include/libcpu/grlib-tn-0018.h
+++ b/cpukit/score/cpu/sparc/include/libcpu/grlib-tn-0018.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This header file provides interfaces of the
+ * LEON3 TN0018 fix.
+ */
+
/*
* Copyright (C) 2020 Cobham Gailer AB
*
diff --git a/cpukit/score/cpu/sparc/include/rtems/asm.h b/cpukit/score/cpu/sparc/include/rtems/asm.h
index de65f35d2c..1b4e949842 100644
--- a/cpukit/score/cpu/sparc/include/rtems/asm.h
+++ b/cpukit/score/cpu/sparc/include/rtems/asm.h
@@ -1,6 +1,8 @@
/**
* @file
*
+ * @ingroup RTEMSScoreCPUSPARCASM
+ *
* @brief Address the Problems Caused by Incompatible Flavor of
* Assemblers and Toolsets
*
diff --git a/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h b/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h
index 01bb99cda3..c8d4b4c4e7 100644
--- a/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h
+++ b/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h
@@ -1,5 +1,15 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreAtomicCPU
+ *
+ * @brief This header file provides interfaces of the
+ * atomic operations implementation using
+ * functions provided by the C11/C++11.
+ */
+
/*
* COPYRIGHT (c) 2012-2013 Deng Hengyi.
*
diff --git a/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h b/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h
index a62f0a488f..070e39718e 100644
--- a/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h
+++ b/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARC
+ *
+ * @brief This header file provides interfaces of the
+ * _SPARC_Counter and _SPARC_Counter_mutable global variables.
+ */
+
/*
* Copyright (c) 2016, 2018 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/score/cpu/sparc/syscall.h b/cpukit/score/cpu/sparc/syscall.h
index 2f20886840..e7bc95efe3 100644
--- a/cpukit/score/cpu/sparc/syscall.h
+++ b/cpukit/score/cpu/sparc/syscall.h
@@ -1 +1,16 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplSysCall
+ *
+ * @brief This header file provides interfaces of the
+ * SYS_exit SysCall.
+ */
+
+/**
+ * @defgroup RTEMSImplSysCall SysCall Definition for Assembler Interface
+ *
+ * @ingroup RTEMSImpl
+ */
+
#define SYS_exit 1
diff --git a/cpukit/score/src/stackallocatorforidle.c b/cpukit/score/src/stackallocatorforidle.c
index 76b6ace1f4..966375bfcb 100644
--- a/cpukit/score/src/stackallocatorforidle.c
+++ b/cpukit/score/src/stackallocatorforidle.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreStack
+ *
+ * @brief This source file contains a definition of
+ * ::_Stack_Allocator_allocate_for_idle_default.
+ */
+
/*
* SPDX-License-Identifier: BSD-2-Clause
*