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>
This commit is contained in:
Sebastian Huber
2026-09-01 20:17:20 +00:00
committed by Gedare Bloom
parent 3926291a43
commit 4e714dc3f8
13 changed files with 117 additions and 0 deletions
+9
View File
@@ -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
*
@@ -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
*
@@ -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
*
@@ -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
*
@@ -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
*
+9
View File
@@ -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
*
+9
View File
@@ -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
*
@@ -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
*
+9
View File
@@ -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
*
+9
View File
@@ -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
*
+9
View File
@@ -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
*
+9
View File
@@ -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
*
+9
View File
@@ -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
*