Canonicalize the file headers. Update #3707. --- cpukit/include/rtems/test-info.h | 9 +++++++++ cpukit/include/rtems/test.h | 13 +++++++++++-- cpukit/libtest/t-test-busy-tick.c | 3 ++- cpukit/libtest/t-test-busy.c | 3 ++- cpukit/libtest/t-test-checks-eno.c | 13 +++++++++++-- cpukit/libtest/t-test-checks-psx.c | 5 ++++- cpukit/libtest/t-test-checks.c | 13 +++++++++++-- cpukit/libtest/t-test-hash-sha256.c | 13 +++++++++++-- cpukit/libtest/t-test-interrupt.c | 3 ++- cpukit/libtest/t-test-rtems-context.c | 13 +++++++++++-- cpukit/libtest/t-test-rtems-fds.c | 13 +++++++++++-- cpukit/libtest/t-test-rtems-heap.c | 13 +++++++++++-- cpukit/libtest/t-test-rtems-measure.c | 13 +++++++++++-- cpukit/libtest/t-test-rtems-memory.c | 9 +++++++++ cpukit/libtest/t-test-rtems-objs.c | 5 +++-- cpukit/libtest/t-test-rtems-posix-keys.c | 5 +++-- cpukit/libtest/t-test-rtems.c | 13 +++++++++++-- cpukit/libtest/t-test-rtems.h | 5 +++-- cpukit/libtest/t-test-thread-switch.c | 3 ++- cpukit/libtest/t-test-time.c | 13 +++++++++++-- cpukit/libtest/t-test.c | 13 +++++++++++-- cpukit/libtest/testbeginend.c | 9 +++++++++ 22 files changed, 169 insertions(+), 33 deletions(-)
diff --git a/cpukit/include/rtems/test-info.h b/cpukit/include/rtems/test-info.h index 055ed4f25b..c1b41ccc6e 100644 --- a/cpukit/include/rtems/test-info.h +++ b/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 * diff --git a/cpukit/include/rtems/test.h b/cpukit/include/rtems/test.h index 79313343a0..04eebd6e75 100644 --- a/cpukit/include/rtems/test.h +++ b/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 diff --git a/cpukit/libtest/t-test-busy-tick.c b/cpukit/libtest/t-test-busy-tick.c index b7fed247fa..5e45757f24 100644 --- a/cpukit/libtest/t-test-busy-tick.c +++ b/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(). */ /* diff --git a/cpukit/libtest/t-test-busy.c b/cpukit/libtest/t-test-busy.c index 8583284087..e28fa3e5e4 100644 --- a/cpukit/libtest/t-test-busy.c +++ b/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(). */ /* diff --git a/cpukit/libtest/t-test-checks-eno.c b/cpukit/libtest/t-test-checks-eno.c index 5b450ccf99..48736915b4 100644 --- a/cpukit/libtest/t-test-checks-eno.c +++ b/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 diff --git a/cpukit/libtest/t-test-checks-psx.c b/cpukit/libtest/t-test-checks-psx.c index 5394ea537a..5d6ec25bda 100644 --- a/cpukit/libtest/t-test-checks-psx.c +++ b/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(). */ /* diff --git a/cpukit/libtest/t-test-checks.c b/cpukit/libtest/t-test-checks.c index 40479a8277..b83e83f1f3 100644 --- a/cpukit/libtest/t-test-checks.c +++ b/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 diff --git a/cpukit/libtest/t-test-hash-sha256.c b/cpukit/libtest/t-test-hash-sha256.c index a9aa4df023..e937f81ddf 100644 --- a/cpukit/libtest/t-test-hash-sha256.c +++ b/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 diff --git a/cpukit/libtest/t-test-interrupt.c b/cpukit/libtest/t-test-interrupt.c index 800724dd93..8796dc0b5a 100644 --- a/cpukit/libtest/t-test-interrupt.c +++ b/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(). */ /* diff --git a/cpukit/libtest/t-test-rtems-context.c b/cpukit/libtest/t-test-rtems-context.c index 351a29a1ca..1405db0c7d 100644 --- a/cpukit/libtest/t-test-rtems-context.c +++ b/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 diff --git a/cpukit/libtest/t-test-rtems-fds.c b/cpukit/libtest/t-test-rtems-fds.c index df5279f585..2b520972d2 100644 --- a/cpukit/libtest/t-test-rtems-fds.c +++ b/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 diff --git a/cpukit/libtest/t-test-rtems-heap.c b/cpukit/libtest/t-test-rtems-heap.c index ac54e96fc7..2fb069a50e 100644 --- a/cpukit/libtest/t-test-rtems-heap.c +++ b/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 diff --git a/cpukit/libtest/t-test-rtems-measure.c b/cpukit/libtest/t-test-rtems-measure.c index c165fc8f2a..2a2376cd27 100644 --- a/cpukit/libtest/t-test-rtems-measure.c +++ b/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 diff --git a/cpukit/libtest/t-test-rtems-memory.c b/cpukit/libtest/t-test-rtems-memory.c index 1d41192f56..ed0908ae10 100644 --- a/cpukit/libtest/t-test-rtems-memory.c +++ b/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 * diff --git a/cpukit/libtest/t-test-rtems-objs.c b/cpukit/libtest/t-test-rtems-objs.c index 2eb3db6f7f..ce752424b5 100644 --- a/cpukit/libtest/t-test-rtems-objs.c +++ b/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. */ /* diff --git a/cpukit/libtest/t-test-rtems-posix-keys.c b/cpukit/libtest/t-test-rtems-posix-keys.c index a26988e27a..65153d3d33 100644 --- a/cpukit/libtest/t-test-rtems-posix-keys.c +++ b/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(). */ /* diff --git a/cpukit/libtest/t-test-rtems.c b/cpukit/libtest/t-test-rtems.c index 97864c1c76..d4fc6827af 100644 --- a/cpukit/libtest/t-test-rtems.c +++ b/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 diff --git a/cpukit/libtest/t-test-rtems.h b/cpukit/libtest/t-test-rtems.h index 9d40f1aa9b..d429c4f5bd 100644 --- a/cpukit/libtest/t-test-rtems.h +++ b/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. */ /* diff --git a/cpukit/libtest/t-test-thread-switch.c b/cpukit/libtest/t-test-thread-switch.c index 44cd819dd1..99d2d7ee29 100644 --- a/cpukit/libtest/t-test-thread-switch.c +++ b/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. */ /* diff --git a/cpukit/libtest/t-test-time.c b/cpukit/libtest/t-test-time.c index 3f953626a5..2acb75f799 100644 --- a/cpukit/libtest/t-test-time.c +++ b/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 diff --git a/cpukit/libtest/t-test.c b/cpukit/libtest/t-test.c index 4f3bf56142..427b3b426a 100644 --- a/cpukit/libtest/t-test.c +++ b/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 diff --git a/cpukit/libtest/testbeginend.c b/cpukit/libtest/testbeginend.c index 067155fef3..546fdf65ff 100644 --- a/cpukit/libtest/testbeginend.c +++ b/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 * -- 2.35.3 _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
