From 774c339f0be964bfe598410a3cba428650269e1d Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 19 Aug 2026 05:51:01 +0200 Subject: [PATCH] cpukit: Write the dynamic linker Doxygen briefs The briefs of the dynamic linker named a topic, not the content of the file. Three of them named the wrong topic. The files rtl-obj.c and rtl-find-file.c both said "RTEMS Run-Time Linker Error". The header rtl-rap.h said "RTEMS Run-Time Linker ELF Headers". Write every brief in the style of the tree. Do the same for the four Doxygen support headers and for the remaining single files in aio, endian, memory, mqueue, pci, libgnat, ftpd and libdebugger. Put @file, @ingroup and @brief in this order in every block. The header appl-config.h keeps its brief. A generator produces that file. Updates #5717. Assisted-by: Claude:claude-opus-5 claude-code Signed-off-by: Sebastian Huber --- cpukit/doxygen/build.h | 3 ++- cpukit/doxygen/hash-algorithms.h | 3 ++- cpukit/doxygen/mainpage.h | 4 ++-- cpukit/doxygen/top-level-groups.h | 3 ++- cpukit/ftpd/ftpd.c | 2 +- cpukit/include/aio.h | 7 ++++--- cpukit/include/endian.h | 5 +++-- cpukit/include/memory.h | 5 +++-- cpukit/include/mqueue.h | 7 ++++--- cpukit/include/pci.h | 3 +-- cpukit/libdebugger/rtems-debugger-microblaze.c | 3 ++- cpukit/libdl/dlfcn-shell.c | 3 ++- cpukit/libdl/dlfcn.c | 3 ++- cpukit/libdl/rap-shell.c | 2 +- cpukit/libdl/rap.c | 2 +- cpukit/libdl/rtl-alloc-heap.c | 3 ++- cpukit/libdl/rtl-alloc-heap.h | 3 ++- cpukit/libdl/rtl-allocator.c | 2 +- cpukit/libdl/rtl-archive.c | 3 ++- cpukit/libdl/rtl-bit-alloc.c | 2 +- cpukit/libdl/rtl-bit-alloc.h | 3 ++- cpukit/libdl/rtl-chain-iterator.c | 3 ++- cpukit/libdl/rtl-chain-iterator.h | 3 ++- cpukit/libdl/rtl-debugger.c | 3 ++- cpukit/libdl/rtl-elf.c | 2 +- cpukit/libdl/rtl-elf.h | 3 ++- cpukit/libdl/rtl-error.c | 2 +- cpukit/libdl/rtl-error.h | 3 ++- cpukit/libdl/rtl-find-file.c | 3 ++- cpukit/libdl/rtl-find-file.h | 3 ++- cpukit/libdl/rtl-mdreloc-lm32.c | 5 +++-- cpukit/libdl/rtl-mdreloc-mips.c | 5 +++-- cpukit/libdl/rtl-mdreloc-moxie.c | 5 +++-- cpukit/libdl/rtl-mdreloc-powerpc.c | 5 +++-- cpukit/libdl/rtl-obj-cache.c | 4 ++-- cpukit/libdl/rtl-obj-comp.c | 4 ++-- cpukit/libdl/rtl-obj.c | 3 ++- cpukit/libdl/rtl-rap.c | 3 ++- cpukit/libdl/rtl-rap.h | 3 ++- cpukit/libdl/rtl-shell.c | 3 ++- cpukit/libdl/rtl-string.c | 3 ++- cpukit/libdl/rtl-string.h | 3 ++- cpukit/libdl/rtl-sym.c | 2 +- cpukit/libdl/rtl-tls.c | 3 ++- cpukit/libdl/rtl-tls.h | 3 ++- cpukit/libdl/rtl-trace.c | 2 +- cpukit/libdl/rtl-trampoline.h | 3 ++- cpukit/libdl/rtl-unresolved.c | 3 ++- cpukit/libdl/rtl-unwind-dw2.c | 3 ++- cpukit/libdl/rtl-unwind-dw2.h | 3 ++- cpukit/libdl/rtl-unwind.h | 3 ++- cpukit/libdl/rtl.c | 3 ++- cpukit/libgnat/adasupp.c | 5 +++-- 53 files changed, 107 insertions(+), 68 deletions(-) diff --git a/cpukit/doxygen/build.h b/cpukit/doxygen/build.h index f6f4b3ce98..5316c342d9 100644 --- a/cpukit/doxygen/build.h +++ b/cpukit/doxygen/build.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDoxygen * - * @brief This header file defines build system related Doxygen items. + * @brief This header file provides the Doxygen definitions of the build + * system. */ /* diff --git a/cpukit/doxygen/hash-algorithms.h b/cpukit/doxygen/hash-algorithms.h index 499d04c1ed..1ea864b81a 100644 --- a/cpukit/doxygen/hash-algorithms.h +++ b/cpukit/doxygen/hash-algorithms.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDoxygen * - * @brief This header file contains Doxygen items related to hash algorithms. + * @brief This header file provides the Doxygen definitions of the hash + * algorithms. */ /* diff --git a/cpukit/doxygen/mainpage.h b/cpukit/doxygen/mainpage.h index e7ae5fed01..8c9b3ddcaf 100644 --- a/cpukit/doxygen/mainpage.h +++ b/cpukit/doxygen/mainpage.h @@ -5,8 +5,8 @@ * * @ingroup RTEMSImplDoxygen * - * @brief This file exists to provide a top level description of RTEMS for - * Doxygen. + * @brief This header file provides the main page of the generated + * documentation. */ /* diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h index 67156bfa97..2081056dc6 100644 --- a/cpukit/doxygen/top-level-groups.h +++ b/cpukit/doxygen/top-level-groups.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDoxygen * - * @brief This header file defines high level Doxygen groups. + * @brief This header file provides the high level Doxygen group + * definitions. */ /* diff --git a/cpukit/ftpd/ftpd.c b/cpukit/ftpd/ftpd.c index faad9d38e7..2eb5326240 100644 --- a/cpukit/ftpd/ftpd.c +++ b/cpukit/ftpd/ftpd.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplFTPD * - * @brief + * @brief This source file contains the implementation of the FTP daemon. */ /* FIXME: 1. Parse command is a hack. We can do better. diff --git a/cpukit/include/aio.h b/cpukit/include/aio.h index 7e9aa66b66..ec5e4bc7e1 100644 --- a/cpukit/include/aio.h +++ b/cpukit/include/aio.h @@ -4,9 +4,10 @@ * @file * * @ingroup RTEMSImplPOSIXAio - * - * @brief POSIX Asynchronous I/O Support - * + * + * @brief This header file provides the interfaces of the POSIX asynchronous + * input and output support. + * * This file contains the definitions related to POSIX I/O. */ diff --git a/cpukit/include/endian.h b/cpukit/include/endian.h index 6088edb62d..68d1f541fc 100644 --- a/cpukit/include/endian.h +++ b/cpukit/include/endian.h @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplFreeBSDKernel * - * @brief + * @brief This header file provides the byte order definitions used by + * ported components. */ /* diff --git a/cpukit/include/memory.h b/cpukit/include/memory.h index de0fe3b301..b424812f1c 100644 --- a/cpukit/include/memory.h +++ b/cpukit/include/memory.h @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplFreeBSDKernel * - * @brief Dummy include file for FreeBSD routines + * @brief This header file provides the memory function declarations used by + * ported components. */ /* diff --git a/cpukit/include/mqueue.h b/cpukit/include/mqueue.h index dfb5bcc606..51c7923454 100644 --- a/cpukit/include/mqueue.h +++ b/cpukit/include/mqueue.h @@ -5,10 +5,11 @@ * * @ingroup RTEMSImplPOSIXMessageQueue * - * @brief POSIX Message Queues - * + * @brief This header file provides the interfaces of the POSIX message + * queues. + * * This file contains the definitions related to POSIX Message Queues. - * + * * The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message * queues at a future date. They are currently not part of the diff --git a/cpukit/include/pci.h b/cpukit/include/pci.h index 440d420152..747ebc0f28 100644 --- a/cpukit/include/pci.h +++ b/cpukit/include/pci.h @@ -5,11 +5,10 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI Library + * @brief This header file provides the interfaces of the PCI library. * * Defines in this file was taken from FreeBSD and auto-generated * pci_ids.h reused from RTEMS. - * */ /* diff --git a/cpukit/libdebugger/rtems-debugger-microblaze.c b/cpukit/libdebugger/rtems-debugger-microblaze.c index 55bd7480d3..cf49a2d85d 100644 --- a/cpukit/libdebugger/rtems-debugger-microblaze.c +++ b/cpukit/libdebugger/rtems-debugger-microblaze.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDebugger * - * @brief MicroBlaze libdebugger implementation + * @brief This source file contains the MicroBlaze target support of the + * debugger server. */ /* diff --git a/cpukit/libdl/dlfcn-shell.c b/cpukit/libdl/dlfcn-shell.c index 21181523e9..540506981e 100644 --- a/cpukit/libdl/dlfcn-shell.c +++ b/cpukit/libdl/dlfcn-shell.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Dynamic Loading API Shell Support. + * @brief This source file contains the shell commands of the dynamic + * linker. * * Shell command wrappers for the Dynamic Loading API. */ diff --git a/cpukit/libdl/dlfcn.c b/cpukit/libdl/dlfcn.c index 01a0c06310..2562f08067 100644 --- a/cpukit/libdl/dlfcn.c +++ b/cpukit/libdl/dlfcn.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS POSIX Dynamic Module Loading Interface. + * @brief This source file contains the implementation of dlopen(), + * dlclose(), dlsym(), dlerror() and dlinfo(). * * This is the POSIX interface to run-time loading of code into RTEMS. */ diff --git a/cpukit/libdl/rap-shell.c b/cpukit/libdl/rap-shell.c index 302a337430..48550d5e28 100644 --- a/cpukit/libdl/rap-shell.c +++ b/cpukit/libdl/rap-shell.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Application Loader. + * @brief This source file contains the shell command of the RAP loader. * * Shell command wrappers for the RTEMS Application loader. */ diff --git a/cpukit/libdl/rap.c b/cpukit/libdl/rap.c index 7b0eebacac..a8d47e6e70 100644 --- a/cpukit/libdl/rap.c +++ b/cpukit/libdl/rap.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDLRAP * - * @brief RTEMS Application Loader + * @brief This source file contains the implementation of the RAP loader. * * This is the RAP implementation. */ diff --git a/cpukit/libdl/rtl-alloc-heap.c b/cpukit/libdl/rtl-alloc-heap.c index ddb5f4fd9f..5534a54180 100644 --- a/cpukit/libdl/rtl-alloc-heap.c +++ b/cpukit/libdl/rtl-alloc-heap.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Allocator for the standard heap. + * @brief This source file contains the heap allocator of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-alloc-heap.h b/cpukit/libdl/rtl-alloc-heap.h index b62e6efead..a1df8ec271 100644 --- a/cpukit/libdl/rtl-alloc-heap.h +++ b/cpukit/libdl/rtl-alloc-heap.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Allocator for the standard heap. + * @brief This header file provides the heap allocator interfaces of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-allocator.c b/cpukit/libdl/rtl-allocator.c index faa918bbed..e69d6626a8 100644 --- a/cpukit/libdl/rtl-allocator.c +++ b/cpukit/libdl/rtl-allocator.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Allocator + * @brief This source file contains the allocator of the dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-archive.c b/cpukit/libdl/rtl-archive.c index 9d075856cd..c4d1a163e3 100644 --- a/cpukit/libdl/rtl-archive.c +++ b/cpukit/libdl/rtl-archive.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Archive + * @brief This source file contains the archive support of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-bit-alloc.c b/cpukit/libdl/rtl-bit-alloc.c index 96f13b775b..ebd3c6c747 100644 --- a/cpukit/libdl/rtl-bit-alloc.c +++ b/cpukit/libdl/rtl-bit-alloc.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Bit Allocator + * @brief This source file contains the bit allocator of the dynamic linker. * * A configurable allocator for small peices of memory where embedding * control blocks into the memory are not viable. The amount of memory diff --git a/cpukit/libdl/rtl-bit-alloc.h b/cpukit/libdl/rtl-bit-alloc.h index b862347811..5f5ba9b670 100644 --- a/cpukit/libdl/rtl-bit-alloc.h +++ b/cpukit/libdl/rtl-bit-alloc.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Bit Allocator Header + * @brief This header file provides the bit allocator interfaces of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-chain-iterator.c b/cpukit/libdl/rtl-chain-iterator.c index c03f508cee..9f66838b70 100644 --- a/cpukit/libdl/rtl-chain-iterator.c +++ b/cpukit/libdl/rtl-chain-iterator.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Chain Iterator + * @brief This source file contains the chain iterator of the dynamic + * linker. * * A means of executing an iterator on a chain. */ diff --git a/cpukit/libdl/rtl-chain-iterator.h b/cpukit/libdl/rtl-chain-iterator.h index cd43ff3940..6ac24cef9d 100644 --- a/cpukit/libdl/rtl-chain-iterator.h +++ b/cpukit/libdl/rtl-chain-iterator.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Chain Iterator. + * @brief This header file provides the chain iterator interfaces of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-debugger.c b/cpukit/libdl/rtl-debugger.c index a13ecd513c..3b10a99132 100644 --- a/cpukit/libdl/rtl-debugger.c +++ b/cpukit/libdl/rtl-debugger.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Module Loading Debugger Interface. + * @brief This source file contains the debugger interface of the dynamic + * linker. * * Inspection of run-time linkers in NetBSD and Android show a common type of * structure that is used to interface to GDB. The NetBSD definition of this diff --git a/cpukit/libdl/rtl-elf.c b/cpukit/libdl/rtl-elf.c index 3f72b64b2e..3128732608 100644 --- a/cpukit/libdl/rtl-elf.c +++ b/cpukit/libdl/rtl-elf.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor + * @brief This source file contains the ELF support of the dynamic linker. * * This is the RTL implementation. */ diff --git a/cpukit/libdl/rtl-elf.h b/cpukit/libdl/rtl-elf.h index 3a3d906a9b..520fc23d25 100644 --- a/cpukit/libdl/rtl-elf.h +++ b/cpukit/libdl/rtl-elf.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker ELF Headers + * @brief This header file provides the ELF interfaces of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-error.c b/cpukit/libdl/rtl-error.c index cea890c323..5eaee26e11 100644 --- a/cpukit/libdl/rtl-error.c +++ b/cpukit/libdl/rtl-error.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Error + * @brief This source file contains the error support of the dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-error.h b/cpukit/libdl/rtl-error.h index f562aaec47..ac0f9ac49e 100644 --- a/cpukit/libdl/rtl-error.h +++ b/cpukit/libdl/rtl-error.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Error + * @brief This header file provides the error interfaces of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-find-file.c b/cpukit/libdl/rtl-find-file.c index 1c106d670f..da913751ed 100644 --- a/cpukit/libdl/rtl-find-file.c +++ b/cpukit/libdl/rtl-find-file.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Error + * @brief This source file contains the implementation of + * rtems_rtl_find_file(). */ /* diff --git a/cpukit/libdl/rtl-find-file.h b/cpukit/libdl/rtl-find-file.h index bc66861eef..8a69f85c32 100644 --- a/cpukit/libdl/rtl-find-file.h +++ b/cpukit/libdl/rtl-find-file.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object Support. + * @brief This header file provides the file lookup interfaces of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-mdreloc-lm32.c b/cpukit/libdl/rtl-mdreloc-lm32.c index d64fbb92f7..d23c32b0f5 100644 --- a/cpukit/libdl/rtl-mdreloc-lm32.c +++ b/cpukit/libdl/rtl-mdreloc-lm32.c @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplLibDL * - * @brief + * @brief This source file contains the LatticeMico32 relocation support of + * the dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-mdreloc-mips.c b/cpukit/libdl/rtl-mdreloc-mips.c index a5f157774b..3d46a64c20 100644 --- a/cpukit/libdl/rtl-mdreloc-mips.c +++ b/cpukit/libdl/rtl-mdreloc-mips.c @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplLibDL * - * @brief + * @brief This source file contains the MIPS relocation support of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-mdreloc-moxie.c b/cpukit/libdl/rtl-mdreloc-moxie.c index be5263d399..c1195179aa 100644 --- a/cpukit/libdl/rtl-mdreloc-moxie.c +++ b/cpukit/libdl/rtl-mdreloc-moxie.c @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplLibDL * - * @brief + * @brief This source file contains the Moxie relocation support of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-mdreloc-powerpc.c b/cpukit/libdl/rtl-mdreloc-powerpc.c index 3a9aa9504c..fc3bc30297 100644 --- a/cpukit/libdl/rtl-mdreloc-powerpc.c +++ b/cpukit/libdl/rtl-mdreloc-powerpc.c @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplLibDL * - * @brief + * @brief This source file contains the PowerPC relocation support of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-obj-cache.c b/cpukit/libdl/rtl-obj-cache.c index 823a61b5a4..0c08abff1e 100644 --- a/cpukit/libdl/rtl-obj-cache.c +++ b/cpukit/libdl/rtl-obj-cache.c @@ -5,8 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object File cache buffers a section of the - * object file in a buffer to localise read performance. + * @brief This source file contains the object file cache of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-obj-comp.c b/cpukit/libdl/rtl-obj-comp.c index 513127d524..84813f6557 100644 --- a/cpukit/libdl/rtl-obj-comp.c +++ b/cpukit/libdl/rtl-obj-comp.c @@ -5,8 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object Compression manages a compress - * stream of data. + * @brief This source file contains the object file decompressor of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-obj.c b/cpukit/libdl/rtl-obj.c index 88cbba7c29..8d04f07576 100644 --- a/cpukit/libdl/rtl-obj.c +++ b/cpukit/libdl/rtl-obj.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Error + * @brief This source file contains the object file support of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-rap.c b/cpukit/libdl/rtl-rap.c index ad6bdd3a03..c9d5ac9987 100644 --- a/cpukit/libdl/rtl-rap.c +++ b/cpukit/libdl/rtl-rap.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor + * @brief This source file contains the RAP file support of the dynamic + * linker. * * This is the RAP format loader support.. */ diff --git a/cpukit/libdl/rtl-rap.h b/cpukit/libdl/rtl-rap.h index f75dc62737..919ac5650a 100644 --- a/cpukit/libdl/rtl-rap.h +++ b/cpukit/libdl/rtl-rap.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker ELF Headers + * @brief This header file provides the RAP file interfaces of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-shell.c b/cpukit/libdl/rtl-shell.c index b62e767a4c..5ecad661d3 100644 --- a/cpukit/libdl/rtl-shell.c +++ b/cpukit/libdl/rtl-shell.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Shell Commands + * @brief This source file contains the shell commands of the dynamic + * linker. * * A simple RTL command to aid using the RTL. */ diff --git a/cpukit/libdl/rtl-string.c b/cpukit/libdl/rtl-string.c index 489eb7b7d2..73c793253d 100644 --- a/cpukit/libdl/rtl-string.c +++ b/cpukit/libdl/rtl-string.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker String managment. + * @brief This source file contains the implementation of + * rtems_rtl_strdup(). */ /* diff --git a/cpukit/libdl/rtl-string.h b/cpukit/libdl/rtl-string.h index b278296e4a..0409a98782 100644 --- a/cpukit/libdl/rtl-string.h +++ b/cpukit/libdl/rtl-string.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker String managment. + * @brief This header file provides the string interfaces of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl-sym.c b/cpukit/libdl/rtl-sym.c index d3c40c23a9..4f7d9656a0 100644 --- a/cpukit/libdl/rtl-sym.c +++ b/cpukit/libdl/rtl-sym.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object File Symbol Table. + * @brief This source file contains the symbol table of the dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-tls.c b/cpukit/libdl/rtl-tls.c index 26bb7480af..92e16a6a52 100644 --- a/cpukit/libdl/rtl-tls.c +++ b/cpukit/libdl/rtl-tls.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Thread Local Storage + * @brief This source file contains the thread-local storage support of the + * dynamic linker. * * TLS support the RTL. */ diff --git a/cpukit/libdl/rtl-tls.h b/cpukit/libdl/rtl-tls.h index 36894accde..015a9818eb 100644 --- a/cpukit/libdl/rtl-tls.h +++ b/cpukit/libdl/rtl-tls.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Thread Local Storage + * @brief This header file provides the thread-local storage interfaces of + * the dynamic linker. * * TLS support the RTL. */ diff --git a/cpukit/libdl/rtl-trace.c b/cpukit/libdl/rtl-trace.c index 09376332a9..4ce795c643 100644 --- a/cpukit/libdl/rtl-trace.c +++ b/cpukit/libdl/rtl-trace.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor Trace + * @brief This source file contains the trace support of the dynamic linker. * * A configurable tracer for the RTL. See the header file for the enable and * disable. diff --git a/cpukit/libdl/rtl-trampoline.h b/cpukit/libdl/rtl-trampoline.h index 9ca05f24c6..db8a6e78cc 100644 --- a/cpukit/libdl/rtl-trampoline.h +++ b/cpukit/libdl/rtl-trampoline.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object File Trampoline Relocations Table. + * @brief This header file provides the trampoline interfaces of the dynamic + * linker. * * Cache relocation records that could result in a trampoline. The unresolved * symbol table holds variable the symbol name (length string) and the object diff --git a/cpukit/libdl/rtl-unresolved.c b/cpukit/libdl/rtl-unresolved.c index 76f686e834..4cadb9666e 100644 --- a/cpukit/libdl/rtl-unresolved.c +++ b/cpukit/libdl/rtl-unresolved.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Object File Unresolved Relocations Table. + * @brief This source file contains the unresolved symbol table of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-unwind-dw2.c b/cpukit/libdl/rtl-unwind-dw2.c index 8dc57bbebf..5b8adbdfd0 100644 --- a/cpukit/libdl/rtl-unwind-dw2.c +++ b/cpukit/libdl/rtl-unwind-dw2.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor + * @brief This source file contains the DWARF 2 unwind support of the + * dynamic linker. * * This is the RTL implementation. */ diff --git a/cpukit/libdl/rtl-unwind-dw2.h b/cpukit/libdl/rtl-unwind-dw2.h index 387a592a6e..c308384342 100644 --- a/cpukit/libdl/rtl-unwind-dw2.h +++ b/cpukit/libdl/rtl-unwind-dw2.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Unwind DWARF Support. + * @brief This header file provides the DWARF 2 unwind interfaces of the + * dynamic linker. */ /* diff --git a/cpukit/libdl/rtl-unwind.h b/cpukit/libdl/rtl-unwind.h index 28b99f5093..1e57637a43 100644 --- a/cpukit/libdl/rtl-unwind.h +++ b/cpukit/libdl/rtl-unwind.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Linker Unwind Support. + * @brief This header file provides the unwind interfaces of the dynamic + * linker. */ /* diff --git a/cpukit/libdl/rtl.c b/cpukit/libdl/rtl.c index 3247c75c31..be8005594d 100644 --- a/cpukit/libdl/rtl.c +++ b/cpukit/libdl/rtl.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplLibDL * - * @brief RTEMS Run-Time Link Editor + * @brief This source file contains the implementation of the dynamic + * linker. * * This is the RTL implementation. */ diff --git a/cpukit/libgnat/adasupp.c b/cpukit/libgnat/adasupp.c index e6afebb566..bb11532152 100644 --- a/cpukit/libgnat/adasupp.c +++ b/cpukit/libgnat/adasupp.c @@ -1,11 +1,12 @@ /* SPDX-License-Identifier: BSD-2-Clause */ /** - * @file + * @file * * @ingroup RTEMSImplGnat * - * @brief ada supplmental functions + * @brief This source file contains the support functions of the Ada + * run-time. */ /*