libtest: Place files into a Doxygen group

Canonicalize the file headers.

Update #3707.

cpukit/include/rtems/test-info.h

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This header file provides interfaces of the
+ *   RTEMS Test Framework.
+ */
+
 /*
  * Copyright (C) 2014, 2018 embedded brains GmbH & Co. KG
  *

cpukit/include/rtems/test.h

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFramework
+ *
+ * @brief This header file provides interfaces of the
+ *   RTEMS Test Framework.
+ */
+
+/*
  * Copyright (C) 2017, 2021 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-busy-tick.c

@@ -5,7 +5,8 @@
  *
  * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief Implementation of T_get_one_clock_tick_busy().
+ * @brief This source file contains the implementation of
+ *   T_get_one_clock_tick_busy().
  */
 
 /*

cpukit/libtest/t-test-busy.c

@@ -5,7 +5,8 @@
  *
  * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief Implementation of T_busy().
+ * @brief This source file contains the implementation of
+ *   T_busy().
  */
 
 /*

cpukit/libtest/t-test-checks-eno.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_strerror(), T_check_eno(), and T_check_eno_success().
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-checks-psx.c

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_check_psx_error() and T_check_psx_success().
  */
 
 /*

cpukit/libtest/t-test-checks.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of various RTEMS Test
+ *   Framework check functions.
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-hash-sha256.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_report_hash_sha256_update() and T_report_hash_sha256().
+ */
+
+/*
  * Copyright (C) 2019, 2021 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-interrupt.c

@@ -5,7 +5,8 @@
  *
  * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief Implementation of T_interrupt_test().
+ * @brief This source file contains the implementation of
+ *   T_interrupt_test().
  */
 
 /*

cpukit/libtest/t-test-rtems-context.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_check_task_context().
+ */
+
+/*
  * Copyright (C) 2019 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-rtems-fds.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_check_file_descriptors().
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-rtems-heap.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_check_heap().
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-rtems-measure.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_measure_runtime().
+ */
+
+/*
  * Copyright (C) 2018, 2021 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-rtems-memory.c

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_memory_allocate(), T_memory_deallocate(), and T_memory_action().
+ */
+
 /*
  * Copyright (C) 2020 embedded brains GmbH & Co. KG
  *

cpukit/libtest/t-test-rtems-objs.c

@@ -3,9 +3,10 @@
 /**
  * @file
  *
- * @ingroup RTEMSTestFramework
+ * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief RTEMS Objects Support for Test Framework
+ * @brief This source file contains the implementation of the RTEMS objects
+ *   test support.
  */
 
 /*

cpukit/libtest/t-test-rtems-posix-keys.c

@@ -3,9 +3,10 @@
 /**
  * @file
  *
- * @ingroup RTEMSTestFramework
+ * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief RTEMS POSIX Keys Support for Test Framework
+ * @brief This source file contains the implementation of
+ *   T_check_posix_keys().
  */
 
 /*

cpukit/libtest/t-test-rtems.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   T_putchar_default(), T_check_rsc(), and T_check_rsc_success().
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test-rtems.h

@@ -3,9 +3,10 @@
 /**
  * @file
  *
- * @ingroup RTEMSTestFrameworkImpl
+ * @ingroup RTEMSTestFramework
  *
- * @brief RTEMS Support for Test Framework
+ * @brief This header file provides the RTEMS-specific API of the RTEMS Test
+ *   Framework.
  */
 
 /*

cpukit/libtest/t-test-thread-switch.c

@@ -5,7 +5,8 @@
  *
  * @ingroup RTEMSTestFrameworkImpl
  *
- * @brief Implementation of T_thread_switch_record().
+ * @brief This source file contains the implementation of the thread switch
+ *   recorder.
  */
 
 /*

cpukit/libtest/t-test-time.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of the time and ticks
+ *   test support.
+ */
+
+/*
  * Copyright (C) 2018 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/t-test.c

@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
  *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the core implementation of RTEMS Test
+ *    Framework.
+ */
+
+/*
  * Copyright (C) 2018, 2020 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/libtest/testbeginend.c

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSTestFrameworkImpl
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_test_begin() and rtems_test_end().
+ */
+
 /*
  * Copyright (C) 2014, 2018 embedded brains GmbH & Co. KG
  *