From 4e714dc3f8cc08499c33f15c9ca03aa005e9c06b Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Wed, 19 Aug 2026 05:32:02 +0200
Subject: [PATCH] cpukit/libtrace: Add the Doxygen file headers

Thirteen of the 14 event record sources had no Doxygen block.  Doxygen
listed only record-fetch.c, so the event recording had almost no
implementation page.

Give each file a block with @file, @ingroup and @brief.  The brief names
what the file implements.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
---
 cpukit/libtrace/record/record-client.c        | 9 +++++++++
 cpukit/libtrace/record/record-dump-base64.c   | 9 +++++++++
 cpukit/libtrace/record/record-dump-fatal.c    | 9 +++++++++
 cpukit/libtrace/record/record-dump-zbase64.c  | 9 +++++++++
 cpukit/libtrace/record/record-dump-zfatal.c   | 9 +++++++++
 cpukit/libtrace/record/record-dump.c          | 9 +++++++++
 cpukit/libtrace/record/record-server.c        | 9 +++++++++
 cpukit/libtrace/record/record-stream-header.c | 9 +++++++++
 cpukit/libtrace/record/record-sysinit.c       | 9 +++++++++
 cpukit/libtrace/record/record-text.c          | 9 +++++++++
 cpukit/libtrace/record/record-userext.c       | 9 +++++++++
 cpukit/libtrace/record/record-util.c          | 9 +++++++++
 cpukit/libtrace/record/record.c               | 9 +++++++++
 13 files changed, 117 insertions(+)

diff --git a/cpukit/libtrace/record/record-client.c b/cpukit/libtrace/record/record-client.c
index bb42657b3e..491799009a 100644
--- a/cpukit/libtrace/record/record-client.c
+++ b/cpukit/libtrace/record/record-client.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the event record
+ *   client.
+ */
+
 /*
  * Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-dump-base64.c b/cpukit/libtrace/record/record-dump-base64.c
index 3af575d633..aee88533ad 100644
--- a/cpukit/libtrace/record/record-dump-base64.c
+++ b/cpukit/libtrace/record/record-dump-base64.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation which dumps the event
+ *   records in Base64.
+ */
+
 /*
  * Copyright (C) 2020 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-dump-fatal.c b/cpukit/libtrace/record/record-dump-fatal.c
index 6e6bfae7bd..e2248080fc 100644
--- a/cpukit/libtrace/record/record-dump-fatal.c
+++ b/cpukit/libtrace/record/record-dump-fatal.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of
+ *   _Record_Fatal_dump_base64().
+ */
+
 /*
  * Copyright (C) 2020, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-dump-zbase64.c b/cpukit/libtrace/record/record-dump-zbase64.c
index 802e68dd81..d4fc932e16 100644
--- a/cpukit/libtrace/record/record-dump-zbase64.c
+++ b/cpukit/libtrace/record/record-dump-zbase64.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation which dumps the event
+ *   records in Base64 with zlib compression.
+ */
+
 /*
  * Copyright (C) 2020 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-dump-zfatal.c b/cpukit/libtrace/record/record-dump-zfatal.c
index 06ddd1cd32..10221ad8e5 100644
--- a/cpukit/libtrace/record/record-dump-zfatal.c
+++ b/cpukit/libtrace/record/record-dump-zfatal.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of
+ *   _Record_Fatal_dump_base64_zlib().
+ */
+
 /*
  * Copyright (C) 2020, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-dump.c b/cpukit/libtrace/record/record-dump.c
index 8867c41da1..7ece7ef4e0 100644
--- a/cpukit/libtrace/record/record-dump.c
+++ b/cpukit/libtrace/record/record-dump.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_record_dump().
+ */
+
 /*
  * Copyright (C) 2020, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-server.c b/cpukit/libtrace/record/record-server.c
index 210979ce66..e17d07b2be 100644
--- a/cpukit/libtrace/record/record-server.c
+++ b/cpukit/libtrace/record/record-server.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the event record
+ *   server.
+ */
+
 /*
  * Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-stream-header.c b/cpukit/libtrace/record/record-stream-header.c
index ba3b38c54b..980e044670 100644
--- a/cpukit/libtrace/record/record-stream-header.c
+++ b/cpukit/libtrace/record/record-stream-header.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of
+ *   _Record_Stream_header_initialize().
+ */
+
 /*
  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-sysinit.c b/cpukit/libtrace/record/record-sysinit.c
index 4b161dbd1d..9cb88bef42 100644
--- a/cpukit/libtrace/record/record-sysinit.c
+++ b/cpukit/libtrace/record/record-sysinit.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the event record
+ *   system initialization.
+ */
+
 /*
  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-text.c b/cpukit/libtrace/record/record-text.c
index 099d4449fe..779f769e30 100644
--- a/cpukit/libtrace/record/record-text.c
+++ b/cpukit/libtrace/record/record-text.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_record_event_text().
+ */
+
 /*
  * Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-userext.c b/cpukit/libtrace/record/record-userext.c
index 83205043f5..20bcdd3eef 100644
--- a/cpukit/libtrace/record/record-userext.c
+++ b/cpukit/libtrace/record/record-userext.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the user
+ *   extensions of the event record support.
+ */
+
 /*
  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record-util.c b/cpukit/libtrace/record/record-util.c
index 055d1340d1..471b61d9fe 100644
--- a/cpukit/libtrace/record/record-util.c
+++ b/cpukit/libtrace/record/record-util.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the event record
+ *   line producers.
+ */
+
 /*
  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
  *
diff --git a/cpukit/libtrace/record/record.c b/cpukit/libtrace/record/record.c
index a5ee73c0fd..a9b6c01b43 100644
--- a/cpukit/libtrace/record/record.c
+++ b/cpukit/libtrace/record/record.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplRecord
+ *
+ * @brief This source file contains the implementation of the event record
+ *   producers.
+ */
+
 /*
  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
  *