The briefs of the libmisc files named a topic, not the content of the
file. Four shell briefs named the wrong command. The file
main_blksync.c said "RM Shell Command Implementation". The files
main_id.c, main_time.c and shellconfig.c named ls and debugrfs. Four
string conversion sources named the conversion, for example "Convert
String to Unsigned Long".
Write every brief in the style of the tree. A source brief starts with
"This source file contains". A command brief names the command the file
provides. A header brief starts with "This header file provides". Put
@file, @ingroup and @brief in this order in every block.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
The capture engine, the monitor and the stdio redirector had no group on
any file. The flattened device tree implementation sat in rtems_fdt,
the group of its API. The string conversion, the BSP command line, the
dump buffer and the stack checker sources sat in the API group of the
interface they implement. Twenty-four files wrote the group title after
the group name, so Doxygen looked for one group per title word.
Give each component the group of its implementation. The stdio
redirector works on file descriptors, so it joins LibIO. Drop the group
title from every @ingroup line.
Updates #5717.
Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
Compiling dumpbuf.c causes the following warning to be issued:
warning: pointer targets in passing argument 1 of 'snprintf' differ in signedness [-Wpointer-sign]
This happens because line_buffer is declared as unsigned.
Closes#2411.
Script does what is expected and tries to do it as
smartly as possible.
+ remove occurrences of two blank comment lines
next to each other after Id string line removed.
+ remove entire comment blocks which only exited to
contain CVS Ids
+ If the processing left a blank line at the top of
a file, it was removed.
Sebastian Huber
Gedare Bloom
Joel Sherrill
Chris Johns
Martin Galvan
Mathew Kallada
Joel Sherrill
Ralf Corsepius