Sebastian Huber 2e50add72a 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 <sebastian.huber@embedded-brains.de>

2026-09-01 20:17:20 +00:00

..

spi

cpukit: Write the driver and PCI Doxygen briefs

2026-09-01 20:17:20 +00:00

i2c-dev.h

cpukit: Write the driver and PCI Doxygen briefs

2026-09-01 20:17:20 +00:00

i2c.h

cpukit: Write the driver and PCI Doxygen briefs

2026-09-01 20:17:20 +00:00

rbtree.h

cpukit: Add the remaining Doxygen file headers

2026-09-01 20:17:20 +00:00