From 2e50add72a2b152adacc9a32e3ef38db32672faa Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 19 Aug 2026 05:50:13 +0200 Subject: [PATCH] cpukit: Write the driver and PCI Doxygen briefs The briefs of the block device drivers and the PCI headers named a topic, not the content of the file. Five libblock files carried the same brief "Media implementation.". Four more carried "RAM disk block device implementation.". Write every brief in the style of the tree. A source brief starts with "This source file contains" and names the functions the file defines where there are at most three. A header brief starts with "This header file provides". Put @file, @ingroup and @brief in this order. The CAN and CAN FD stack keeps its briefs. Its contributors write them in a style of their own. Updates #5717. Assisted-by: Claude:claude-opus-5 claude-code Signed-off-by: Sebastian Huber --- cpukit/dev/i2c/i2c-bus.c | 5 +++-- cpukit/dev/i2c/i2c-dev.c | 5 +++-- cpukit/dev/spi/spi-bus.c | 5 +++-- cpukit/doxygen.h | 3 ++- cpukit/include/dev/flash/flashdev.h | 3 ++- cpukit/include/dev/i2c/i2c.h | 4 ++-- cpukit/include/dev/io/iodev.h | 3 ++- cpukit/include/dev/spi/spi.h | 4 ++-- cpukit/include/drvmgr/drvmgr.h | 2 +- cpukit/include/drvmgr/drvmgr_confdefs.h | 2 +- cpukit/include/drvmgr/drvmgr_list.h | 3 ++- cpukit/include/drvmgr/pci_bus.h | 3 ++- cpukit/include/linux/i2c-dev.h | 5 +++-- cpukit/include/linux/i2c.h | 5 +++-- cpukit/include/linux/spi/spidev.h | 5 +++-- cpukit/include/pci/access.h | 2 +- cpukit/include/pci/cfg.h | 3 ++- cpukit/include/pci/cfg_auto.h | 3 ++- cpukit/include/pci/cfg_peripheral.h | 3 ++- cpukit/include/pci/cfg_read.h | 3 ++- cpukit/include/pci/cfg_static.h | 2 +- cpukit/include/pci/ids_extra.h | 3 ++- cpukit/include/pci/irq.h | 2 +- cpukit/libblock/src/bdbuf.c | 3 ++- cpukit/libblock/src/bdpart-create.c | 3 ++- cpukit/libblock/src/bdpart-dump.c | 3 ++- cpukit/libblock/src/bdpart-read.c | 3 ++- cpukit/libblock/src/bdpart-register.c | 4 +++- cpukit/libblock/src/bdpart-sort.c | 3 ++- cpukit/libblock/src/bdpart-write.c | 3 ++- cpukit/libblock/src/blkdev-blkstats.c | 2 +- cpukit/libblock/src/blkdev-imfs.c | 3 ++- cpukit/libblock/src/blkdev-ioctl.c | 3 ++- cpukit/libblock/src/blkdev-ops.c | 2 +- cpukit/libblock/src/blkdev-print-stats.c | 3 ++- cpukit/libblock/src/blkdev.c | 3 ++- cpukit/libblock/src/diskdevs-init.c | 3 ++- cpukit/libblock/src/diskdevs.c | 3 ++- cpukit/libblock/src/flashdisk.c | 3 ++- cpukit/libblock/src/ide_part_table.c | 4 +++- cpukit/libblock/src/media-desc.c | 3 ++- cpukit/libblock/src/media-dev-ident.c | 3 ++- cpukit/libblock/src/media-path.c | 4 +++- cpukit/libblock/src/media-server.c | 3 ++- cpukit/libblock/src/media.c | 4 +++- cpukit/libblock/src/nvdisk-sram.c | 3 ++- cpukit/libblock/src/nvdisk.c | 3 ++- cpukit/libblock/src/ramdisk-config.c | 3 ++- cpukit/libblock/src/ramdisk-driver.c | 2 +- cpukit/libblock/src/ramdisk-init.c | 3 ++- cpukit/libblock/src/ramdisk-register.c | 3 ++- cpukit/libblock/src/show_bdbuf.c | 3 ++- cpukit/libblock/src/sparse-disk.c | 4 +++- cpukit/libtest/testrun.c | 2 +- cpukit/score/src/exceptionmapping.c | 3 ++- cpukit/score/src/hash.c | 2 +- 56 files changed, 113 insertions(+), 64 deletions(-) diff --git a/cpukit/dev/i2c/i2c-bus.c b/cpukit/dev/i2c/i2c-bus.c index f34758ef10..b675ed69d1 100644 --- a/cpukit/dev/i2c/i2c-bus.c +++ b/cpukit/dev/i2c/i2c-bus.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Inter-Integrated Circuit (I2C) Bus Implementation - * * @ingroup I2CBus + * + * @brief This source file contains the implementation of the I2C bus + * driver. */ /* diff --git a/cpukit/dev/i2c/i2c-dev.c b/cpukit/dev/i2c/i2c-dev.c index 96fe7e70a3..14e677a23f 100644 --- a/cpukit/dev/i2c/i2c-dev.c +++ b/cpukit/dev/i2c/i2c-dev.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Inter-Integrated Circuit (I2C) Bus Implementation - * * @ingroup I2CDevice + * + * @brief This source file contains the implementation of the I2C device + * driver. */ /* diff --git a/cpukit/dev/spi/spi-bus.c b/cpukit/dev/spi/spi-bus.c index 85043e44e5..0d9e4827f1 100644 --- a/cpukit/dev/spi/spi-bus.c +++ b/cpukit/dev/spi/spi-bus.c @@ -1,9 +1,10 @@ /** * @file * - * @brief Serial Peripheral Interface (SPI) Bus Implementation - * * @ingroup SPI + * + * @brief This source file contains the implementation of the SPI bus + * driver. */ /* diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index d43358b306..9daae3195e 100644 --- a/cpukit/doxygen.h +++ b/cpukit/doxygen.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplDoxygen * - * @brief This header file defines some Doxygen groups. + * @brief This header file provides the Doxygen group definitions which no + * other header provides. */ /** diff --git a/cpukit/include/dev/flash/flashdev.h b/cpukit/include/dev/flash/flashdev.h index c37299a853..dff616aceb 100644 --- a/cpukit/include/dev/flash/flashdev.h +++ b/cpukit/include/dev/flash/flashdev.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSGenericFlashAPI * - * @brief Generic Flash API + * @brief This header file provides the interfaces of the generic flash + * device driver. */ /* diff --git a/cpukit/include/dev/i2c/i2c.h b/cpukit/include/dev/i2c/i2c.h index 9114c6be62..cc05b82852 100644 --- a/cpukit/include/dev/i2c/i2c.h +++ b/cpukit/include/dev/i2c/i2c.h @@ -3,9 +3,9 @@ /** * @file * - * @brief Inter-Integrated Circuit (I2C) Driver API - * * @ingroup I2C + * + * @brief This header file provides the interfaces of the I2C bus driver. */ /* diff --git a/cpukit/include/dev/io/iodev.h b/cpukit/include/dev/io/iodev.h index d232342ebc..ad3081dba8 100644 --- a/cpukit/include/dev/io/iodev.h +++ b/cpukit/include/dev/io/iodev.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSGenericIOSpaceAPI * - * @brief Generic IO Device API + * @brief This header file provides the interfaces of the generic I/O device + * driver. */ /* diff --git a/cpukit/include/dev/spi/spi.h b/cpukit/include/dev/spi/spi.h index f1cf25f123..b77d695d8d 100644 --- a/cpukit/include/dev/spi/spi.h +++ b/cpukit/include/dev/spi/spi.h @@ -3,9 +3,9 @@ /** * @file * - * @brief Serial Peripheral Interface (SPI) Driver API - * * @ingroup SPI + * + * @brief This header file provides the interfaces of the SPI bus driver. */ /* diff --git a/cpukit/include/drvmgr/drvmgr.h b/cpukit/include/drvmgr/drvmgr.h index 5b4f7c16cf..f6ec9e07ee 100644 --- a/cpukit/include/drvmgr/drvmgr.h +++ b/cpukit/include/drvmgr/drvmgr.h @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplDriverManager * - * @brief Driver Manager Interface. + * @brief This header file provides the interfaces of the driver manager. */ /* diff --git a/cpukit/include/drvmgr/drvmgr_confdefs.h b/cpukit/include/drvmgr/drvmgr_confdefs.h index 7fc2e9438e..073983143b 100644 --- a/cpukit/include/drvmgr/drvmgr_confdefs.h +++ b/cpukit/include/drvmgr/drvmgr_confdefs.h @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplDriverManager * - * @brief Driver Manager Configuration file. + * @brief This header file provides the configuration of the driver manager. */ /* diff --git a/cpukit/include/drvmgr/drvmgr_list.h b/cpukit/include/drvmgr/drvmgr_list.h index 83bb994fa7..486ec728e4 100644 --- a/cpukit/include/drvmgr/drvmgr_list.h +++ b/cpukit/include/drvmgr/drvmgr_list.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDriverManager * - * @brief Linked list help functions used by driver manager. + * @brief This header file provides the list interfaces of the driver + * manager. */ /* diff --git a/cpukit/include/drvmgr/pci_bus.h b/cpukit/include/drvmgr/pci_bus.h index 5c314eb07d..fd1381fd0d 100644 --- a/cpukit/include/drvmgr/pci_bus.h +++ b/cpukit/include/drvmgr/pci_bus.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplDriverManager * - * @brief PCI bus driver Interface. + * @brief This header file provides the interfaces of the PCI bus driver of + * the driver manager. */ /* diff --git a/cpukit/include/linux/i2c-dev.h b/cpukit/include/linux/i2c-dev.h index 203ccd9504..4ec2f15c06 100644 --- a/cpukit/include/linux/i2c-dev.h +++ b/cpukit/include/linux/i2c-dev.h @@ -3,9 +3,10 @@ /** * @file * - * @brief RTEMS Port of Linux I2C Device API - * * @ingroup I2CLinux + * + * @brief This header file provides the Linux I2C device interfaces ported + * to RTEMS. */ /* diff --git a/cpukit/include/linux/i2c.h b/cpukit/include/linux/i2c.h index c9aa349253..3e52a65a0f 100644 --- a/cpukit/include/linux/i2c.h +++ b/cpukit/include/linux/i2c.h @@ -3,9 +3,10 @@ /** * @file * - * @brief RTEMS Port of Linux I2C API - * * @ingroup I2CLinux + * + * @brief This header file provides the Linux I2C interfaces ported to + * RTEMS. */ /* diff --git a/cpukit/include/linux/spi/spidev.h b/cpukit/include/linux/spi/spidev.h index 33eb29acdc..3cdb9eec5d 100644 --- a/cpukit/include/linux/spi/spidev.h +++ b/cpukit/include/linux/spi/spidev.h @@ -3,9 +3,10 @@ /** * @file * - * @brief RTEMS Port of Linux SPI API - * * @ingroup SPILinux + * + * @brief This header file provides the Linux SPI device interfaces ported + * to RTEMS. */ /* diff --git a/cpukit/include/pci/access.h b/cpukit/include/pci/access.h index 5fc9134900..a7b921d0e7 100644 --- a/cpukit/include/pci/access.h +++ b/cpukit/include/pci/access.h @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI Access Methods + * @brief This header file provides the PCI access interfaces. * * Routines to access PCI memory/configuration space and other PCI related * functions the PCI Library provides. diff --git a/cpukit/include/pci/cfg.h b/cpukit/include/pci/cfg.h index 847f764418..534811d02f 100644 --- a/cpukit/include/pci/cfg.h +++ b/cpukit/include/pci/cfg.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI Configuration Library + * @brief This header file provides the PCI configuration library + * interfaces. */ /* diff --git a/cpukit/include/pci/cfg_auto.h b/cpukit/include/pci/cfg_auto.h index 1e36b2fa21..08fad92aad 100644 --- a/cpukit/include/pci/cfg_auto.h +++ b/cpukit/include/pci/cfg_auto.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI Auto Configuration Library + * @brief This header file provides the automatic PCI configuration + * interfaces. */ /* diff --git a/cpukit/include/pci/cfg_peripheral.h b/cpukit/include/pci/cfg_peripheral.h index 07ddff13e2..a5099aa322 100644 --- a/cpukit/include/pci/cfg_peripheral.h +++ b/cpukit/include/pci/cfg_peripheral.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplPCI * - * @brie PCI Peripheral Configuration Libraryf + * @brief This header file provides the peripheral PCI configuration + * interfaces. */ /* diff --git a/cpukit/include/pci/cfg_read.h b/cpukit/include/pci/cfg_read.h index 5d678c73d4..6b2e2ac569 100644 --- a/cpukit/include/pci/cfg_read.h +++ b/cpukit/include/pci/cfg_read.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI Read Configuration Library + * @brief This header file provides the interfaces which read the PCI + * configuration. * * Read current config where bootloader/BIOS has setup. */ diff --git a/cpukit/include/pci/cfg_static.h b/cpukit/include/pci/cfg_static.h index 76c0bfed58..92a3b253c6 100644 --- a/cpukit/include/pci/cfg_static.h +++ b/cpukit/include/pci/cfg_static.h @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplPCI * - * @brief Static PCI Auto Configuration Library + * @brief This header file provides the static PCI configuration interfaces. */ /* diff --git a/cpukit/include/pci/ids_extra.h b/cpukit/include/pci/ids_extra.h index 853c2be735..d128ac7f4e 100644 --- a/cpukit/include/pci/ids_extra.h +++ b/cpukit/include/pci/ids_extra.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplPCI * - * @brief RTEMS local PCI data base + * @brief This header file provides the PCI identifiers which RTEMS adds to + * the database. */ /* diff --git a/cpukit/include/pci/irq.h b/cpukit/include/pci/irq.h index 3ce948ded7..14356d7bac 100644 --- a/cpukit/include/pci/irq.h +++ b/cpukit/include/pci/irq.h @@ -5,7 +5,7 @@ * * @ingroup RTEMSImplPCI * - * @brief PCI IRQ Library + * @brief This header file provides the PCI interrupt interfaces. */ /* diff --git a/cpukit/libblock/src/bdbuf.c b/cpukit/libblock/src/bdbuf.c index efc18e713e..07af3928f3 100644 --- a/cpukit/libblock/src/bdbuf.c +++ b/cpukit/libblock/src/bdbuf.c @@ -3,7 +3,8 @@ * * @ingroup rtems_bdbuf * - * Block device buffer management. + * @brief This source file contains the implementation of the block device + * buffer cache. */ /* diff --git a/cpukit/libblock/src/bdpart-create.c b/cpukit/libblock/src/bdpart-create.c index b0583889cc..d3430033b1 100644 --- a/cpukit/libblock/src/bdpart-create.c +++ b/cpukit/libblock/src/bdpart-create.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Manage Partitions of a Disk Device + * @brief This source file contains the implementation of + * rtems_bdpart_create(). */ /* diff --git a/cpukit/libblock/src/bdpart-dump.c b/cpukit/libblock/src/bdpart-dump.c index 30dc682539..c42c6f66ce 100644 --- a/cpukit/libblock/src/bdpart-dump.c +++ b/cpukit/libblock/src/bdpart-dump.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Prints the Partition Table @a Partitions with @a Count Partitions + * @brief This source file contains the implementation of + * rtems_bdpart_dump(). */ /* diff --git a/cpukit/libblock/src/bdpart-read.c b/cpukit/libblock/src/bdpart-read.c index e85d303169..25525af253 100644 --- a/cpukit/libblock/src/bdpart-read.c +++ b/cpukit/libblock/src/bdpart-read.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Block Device Partition Management + * @brief This source file contains the implementation which reads the + * partition table of a disk device. */ /* diff --git a/cpukit/libblock/src/bdpart-register.c b/cpukit/libblock/src/bdpart-register.c index 623e0335b6..2e2cbcc0da 100644 --- a/cpukit/libblock/src/bdpart-register.c +++ b/cpukit/libblock/src/bdpart-register.c @@ -5,7 +5,9 @@ * * @ingroup rtems_bdpart * - * @brief Block Device Partition Management + * @brief This source file contains the implementation of + * rtems_bdpart_register(), rtems_bdpart_register_from_disk() and + * rtems_bdpart_unregister(). */ /* diff --git a/cpukit/libblock/src/bdpart-sort.c b/cpukit/libblock/src/bdpart-sort.c index f644ba679f..d3625ed907 100644 --- a/cpukit/libblock/src/bdpart-sort.c +++ b/cpukit/libblock/src/bdpart-sort.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Block Device Partition Management + * @brief This source file contains the implementation of + * rtems_bdpart_sort(). */ /* diff --git a/cpukit/libblock/src/bdpart-write.c b/cpukit/libblock/src/bdpart-write.c index 111f6e8de3..b72983be03 100644 --- a/cpukit/libblock/src/bdpart-write.c +++ b/cpukit/libblock/src/bdpart-write.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Block Device Partition Management + * @brief This source file contains the implementation of + * rtems_bdpart_write(). */ /* diff --git a/cpukit/libblock/src/blkdev-blkstats.c b/cpukit/libblock/src/blkdev-blkstats.c index 48cb5e842c..fc2d770e9d 100644 --- a/cpukit/libblock/src/blkdev-blkstats.c +++ b/cpukit/libblock/src/blkdev-blkstats.c @@ -5,7 +5,7 @@ * * @ingroup rtems_blkdev * - * @brief Block Device Statistics Command + * @brief This source file contains the implementation of rtems_blkstats(). */ /* diff --git a/cpukit/libblock/src/blkdev-imfs.c b/cpukit/libblock/src/blkdev-imfs.c index 9df7dcd5ec..357b7a3d34 100644 --- a/cpukit/libblock/src/blkdev-imfs.c +++ b/cpukit/libblock/src/blkdev-imfs.c @@ -5,7 +5,8 @@ * * @ingroup rtems_blkdev * - * @brief Block Device IMFS + * @brief This source file contains the implementation of + * rtems_blkdev_create() and rtems_blkdev_create_partition(). */ /* diff --git a/cpukit/libblock/src/blkdev-ioctl.c b/cpukit/libblock/src/blkdev-ioctl.c index 9465c8cbf3..35f6d777e6 100644 --- a/cpukit/libblock/src/blkdev-ioctl.c +++ b/cpukit/libblock/src/blkdev-ioctl.c @@ -3,7 +3,8 @@ * * @ingroup rtems_blkdev * - * @brief Common IO Control Primitive + * @brief This source file contains the implementation of + * rtems_blkdev_ioctl(). */ /* diff --git a/cpukit/libblock/src/blkdev-ops.c b/cpukit/libblock/src/blkdev-ops.c index dcac8493b0..a35dbe91f8 100644 --- a/cpukit/libblock/src/blkdev-ops.c +++ b/cpukit/libblock/src/blkdev-ops.c @@ -5,7 +5,7 @@ * * @ingroup rtems_blkdev * - * @brief Block device management. + * @brief This source file contains the block device operations tables. */ /* diff --git a/cpukit/libblock/src/blkdev-print-stats.c b/cpukit/libblock/src/blkdev-print-stats.c index 95e6504cd2..e219a7cb0c 100644 --- a/cpukit/libblock/src/blkdev-print-stats.c +++ b/cpukit/libblock/src/blkdev-print-stats.c @@ -5,7 +5,8 @@ * * @ingroup rtems_blkdev * - * @brief Prints the Block Device Statistics + * @brief This source file contains the implementation of + * rtems_blkdev_print_stats(). */ /* diff --git a/cpukit/libblock/src/blkdev.c b/cpukit/libblock/src/blkdev.c index c23d9f7341..fbbd1375e6 100644 --- a/cpukit/libblock/src/blkdev.c +++ b/cpukit/libblock/src/blkdev.c @@ -3,7 +3,8 @@ * * @ingroup rtems_blkdev * - * @brief Block Device Management + * @brief This source file contains the generic read and write handlers of + * the block device driver. */ /* diff --git a/cpukit/libblock/src/diskdevs-init.c b/cpukit/libblock/src/diskdevs-init.c index 8d85eb1f49..de5055b733 100644 --- a/cpukit/libblock/src/diskdevs-init.c +++ b/cpukit/libblock/src/diskdevs-init.c @@ -5,7 +5,8 @@ * * @ingroup rtems_disk * - * @brief Block Device Disk Management Initialize + * @brief This source file contains the implementation of + * rtems_disk_init_phys() and rtems_disk_init_log(). */ /* diff --git a/cpukit/libblock/src/diskdevs.c b/cpukit/libblock/src/diskdevs.c index ce2214f860..7a78cbe7a2 100644 --- a/cpukit/libblock/src/diskdevs.c +++ b/cpukit/libblock/src/diskdevs.c @@ -3,7 +3,8 @@ * * @ingroup rtems_disk * - * @brief Block device disk management implementation. + * @brief This source file contains the implementation of the disk device + * management. */ /* diff --git a/cpukit/libblock/src/flashdisk.c b/cpukit/libblock/src/flashdisk.c index 0c624de7ba..8c54830544 100644 --- a/cpukit/libblock/src/flashdisk.c +++ b/cpukit/libblock/src/flashdisk.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSFDisk * - * @brief Flash Disk Block Device Implementation + * @brief This source file contains the implementation of + * rtems_fdisk_initialize(). */ /* diff --git a/cpukit/libblock/src/ide_part_table.c b/cpukit/libblock/src/ide_part_table.c index 3c1c869d99..09391b2473 100644 --- a/cpukit/libblock/src/ide_part_table.c +++ b/cpukit/libblock/src/ide_part_table.c @@ -5,7 +5,9 @@ * * @ingroup rtems_libblock * - * @brief Library supporting "MS-DOS-style" Partition Table + * @brief This source file contains the implementation of + * rtems_ide_part_table_free(), rtems_ide_part_table_get() and + * rtems_ide_part_table_initialize(). */ /* diff --git a/cpukit/libblock/src/media-desc.c b/cpukit/libblock/src/media-desc.c index 970c516b18..d7f3be549e 100644 --- a/cpukit/libblock/src/media-desc.c +++ b/cpukit/libblock/src/media-desc.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSDeviceMedia * - * @brief Media implementation. + * @brief This source file contains the implementation of + * rtems_media_event_description() and rtems_media_state_description(). */ /* diff --git a/cpukit/libblock/src/media-dev-ident.c b/cpukit/libblock/src/media-dev-ident.c index bea368c7a9..9510c31ecd 100644 --- a/cpukit/libblock/src/media-dev-ident.c +++ b/cpukit/libblock/src/media-dev-ident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSDeviceMedia * - * @brief Media implementation. + * @brief This source file contains the implementation of + * rtems_media_get_device_identifier(). */ /* diff --git a/cpukit/libblock/src/media-path.c b/cpukit/libblock/src/media-path.c index b498433763..38b32d9c6e 100644 --- a/cpukit/libblock/src/media-path.c +++ b/cpukit/libblock/src/media-path.c @@ -5,7 +5,9 @@ * * @ingroup RTEMSDeviceMedia * - * @brief Media implementation. + * @brief This source file contains the implementation of + * rtems_media_create_path(), rtems_media_replace_prefix() and + * rtems_media_append_minor(). */ /* diff --git a/cpukit/libblock/src/media-server.c b/cpukit/libblock/src/media-server.c index 560103af61..c399ab9bfc 100644 --- a/cpukit/libblock/src/media-server.c +++ b/cpukit/libblock/src/media-server.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSDeviceMedia * - * @brief Media implementation. + * @brief This source file contains the implementation of + * rtems_media_server_initialize() and rtems_media_server_post_event(). */ /* diff --git a/cpukit/libblock/src/media.c b/cpukit/libblock/src/media.c index dff47826ae..1386d1c702 100644 --- a/cpukit/libblock/src/media.c +++ b/cpukit/libblock/src/media.c @@ -5,7 +5,9 @@ * * @ingroup RTEMSDeviceMedia * - * @brief Media implementation. + * @brief This source file contains the implementation of + * rtems_media_listener_add(), rtems_media_listener_remove() and + * rtems_media_post_event(). */ /* diff --git a/cpukit/libblock/src/nvdisk-sram.c b/cpukit/libblock/src/nvdisk-sram.c index 49e60187e3..ee71743dc0 100644 --- a/cpukit/libblock/src/nvdisk-sram.c +++ b/cpukit/libblock/src/nvdisk-sram.c @@ -5,7 +5,8 @@ * * @ingroup rtems_libblock * - * @brief Provide SRAM support for the NV Disk + * @brief This source file contains the SRAM support of the non-volatile + * disk driver. */ /* diff --git a/cpukit/libblock/src/nvdisk.c b/cpukit/libblock/src/nvdisk.c index 8fd76dce73..7db41fe699 100644 --- a/cpukit/libblock/src/nvdisk.c +++ b/cpukit/libblock/src/nvdisk.c @@ -5,7 +5,8 @@ * * @ingroup rtems_libblock * - * @brief Non-Volatile Disk Block Device Implementation + * @brief This source file contains the implementation of + * rtems_nvdisk_initialize(). */ /* diff --git a/cpukit/libblock/src/ramdisk-config.c b/cpukit/libblock/src/ramdisk-config.c index c090fee23d..7b5479d2cc 100644 --- a/cpukit/libblock/src/ramdisk-config.c +++ b/cpukit/libblock/src/ramdisk-config.c @@ -3,7 +3,8 @@ * * @ingroup rtems_ramdisk * - * @brief RAM disk block device implementation. + * @brief This source file contains the implementation of + * ramdisk_initialize(). */ /* diff --git a/cpukit/libblock/src/ramdisk-driver.c b/cpukit/libblock/src/ramdisk-driver.c index a2658a73b6..1b6a8cdee8 100644 --- a/cpukit/libblock/src/ramdisk-driver.c +++ b/cpukit/libblock/src/ramdisk-driver.c @@ -3,7 +3,7 @@ * * @ingroup rtems_ramdisk * - * @brief RAM disk block device implementation. + * @brief This source file contains the implementation of ramdisk_ioctl(). */ /* diff --git a/cpukit/libblock/src/ramdisk-init.c b/cpukit/libblock/src/ramdisk-init.c index 28f1d43c4a..06583ca354 100644 --- a/cpukit/libblock/src/ramdisk-init.c +++ b/cpukit/libblock/src/ramdisk-init.c @@ -5,7 +5,8 @@ * * @ingroup rtems_ramdisk * - * @brief RAM disk block device implementation. + * @brief This source file contains the implementation of ramdisk_allocate() + * and ramdisk_free(). */ /* diff --git a/cpukit/libblock/src/ramdisk-register.c b/cpukit/libblock/src/ramdisk-register.c index e3236507b2..4907c3df13 100644 --- a/cpukit/libblock/src/ramdisk-register.c +++ b/cpukit/libblock/src/ramdisk-register.c @@ -5,7 +5,8 @@ * * @ingroup rtems_ramdisk * - * @brief RAM disk block device implementation. + * @brief This source file contains the implementation of + * ramdisk_register(). */ /* diff --git a/cpukit/libblock/src/show_bdbuf.c b/cpukit/libblock/src/show_bdbuf.c index 2c92422014..a5e788e8c2 100644 --- a/cpukit/libblock/src/show_bdbuf.c +++ b/cpukit/libblock/src/show_bdbuf.c @@ -5,7 +5,8 @@ * * @ingroup rtems_bdpart * - * @brief Enable the Monitor to Show bdbuf Information + * @brief This source file contains the monitor support which shows the + * block device buffer cache. * * This module inspects the bdbuf data structures, * assuming they are static, but in fact they are used very diff --git a/cpukit/libblock/src/sparse-disk.c b/cpukit/libblock/src/sparse-disk.c index 8d16bc6551..fcc28f515c 100644 --- a/cpukit/libblock/src/sparse-disk.c +++ b/cpukit/libblock/src/sparse-disk.c @@ -5,7 +5,9 @@ * * @ingroup rtems_sparse_disk * - * @brief Sparse disk block device implementation. + * @brief This source file contains the implementation of + * rtems_sparse_disk_free(), rtems_sparse_disk_create_and_register() and + * rtems_sparse_disk_register(). */ /* diff --git a/cpukit/libtest/testrun.c b/cpukit/libtest/testrun.c index 9a6567b016..569afec292 100644 --- a/cpukit/libtest/testrun.c +++ b/cpukit/libtest/testrun.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSTest * - * @brief This source file provides the implementation of rtems_test_run(). + * @brief This source file contains the implementation of rtems_test_run(). */ /* diff --git a/cpukit/score/src/exceptionmapping.c b/cpukit/score/src/exceptionmapping.c index cd9323b79f..b34f152862 100644 --- a/cpukit/score/src/exceptionmapping.c +++ b/cpukit/score/src/exceptionmapping.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSScoreException * - * @brief AArch64 machine exception to POSIX signal mapping. + * @brief This source file contains the implementation of + * _Exception_Raise_signal(). */ /* diff --git a/cpukit/score/src/hash.c b/cpukit/score/src/hash.c index 0b9f127e54..8ea4ef97c4 100644 --- a/cpukit/score/src/hash.c +++ b/cpukit/score/src/hash.c @@ -5,7 +5,7 @@ * * @ingroup RTEMSScoreHash * - * @brief This source file the implementation of _Hash_Finalize(). + * @brief This source file contains the implementation of _Hash_Finalize(). */ /*