diff options
Diffstat (limited to 'cpukit')
56 files changed, 520 insertions, 0 deletions
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 fc5f3c0b93..de046f06f5 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, 2021 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 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..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 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 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 4487b02960..da5e44bb02 100644 --- a/cpukit/libcsupport/src/malloc_p.h +++ b/cpukit/libcsupport/src/malloc_p.h @@ -1,3 +1,12 @@ +/** + * @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 32184c3636..34de4a869b 100644 --- a/cpukit/libmisc/cpuuse/cpuuseimpl.h +++ b/cpukit/libmisc/cpuuse/cpuuseimpl.h @@ -1,3 +1,12 @@ +/** + * @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 c0201ec41e..08f9ca2612 100644 --- a/cpukit/libtest/testbeginend.c +++ b/cpukit/libtest/testbeginend.c @@ -1,3 +1,12 @@ +/** + * @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 88403987d2..4f77c649b3 100644 --- a/cpukit/sapi/src/cpucounterconverter.c +++ b/cpukit/sapi/src/cpucounterconverter.c @@ -1,3 +1,12 @@ +/** + * @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 de66b39faa..3b67d2b733 100644 --- a/cpukit/score/cpu/no_cpu/cpuidle.c +++ b/cpukit/score/cpu/no_cpu/cpuidle.c @@ -1,3 +1,12 @@ +/** + * @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 598ee76b20..8684b2a09c 100644 --- a/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h +++ b/cpukit/score/cpu/sparc/include/rtems/score/cpuatomic.h @@ -1,3 +1,13 @@ +/** + * @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 edc03bd074..a6fa704b4d 100644 --- a/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h +++ b/cpukit/score/cpu/sparc/include/rtems/score/sparcimpl.h @@ -1,3 +1,12 @@ +/** + * @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 * |