- More Documentation

- Updated Copyright
2026-01-06 19:48:28 -05:00
parent 93b58ea197
commit 450f725cab
273 changed files with 963 additions and 963 deletions
--- a/test/tests/containers/performance/test_iterator_visitor.h
+++ b/test/tests/containers/performance/test_iterator_visitor.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_array.h
+++ b/test/tests/containers/test_array.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_bintree.h
+++ b/test/tests/containers/test_bintree.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_deque.h
+++ b/test/tests/containers/test_deque.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_dynarray.h
+++ b/test/tests/containers/test_dynarray.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_graph.h
+++ b/test/tests/containers/test_graph.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_list.h
+++ b/test/tests/containers/test_list.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -36,7 +36,7 @@ inline void fennec_test_containers_list() {
 	const size_t n = 50;
 	for (size_t i = 0; i < n; ++i) {
 		const size_t p = rand() % (i + 1);
-		assertf(test.insert(p, i) == i, "List Construct Test Failed.");
+		assertf(test.insert(p, i) != test.end(), "List Construct Test Failed.");
 	}

 	while (test.is_empty() == false) {
--- a/test/tests/containers/test_map.h
+++ b/test/tests/containers/test_map.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_object_pool.h
+++ b/test/tests/containers/test_object_pool.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_optional.h
+++ b/test/tests/containers/test_optional.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_priority_queue.h
+++ b/test/tests/containers/test_priority_queue.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_rdtree.h
+++ b/test/tests/containers/test_rdtree.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_sequence.h
+++ b/test/tests/containers/test_sequence.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,18 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_sequence.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
 #ifndef FENNEC_TEST_CONTAINERS_SEQUENCE_H
 #define FENNEC_TEST_CONTAINERS_SEQUENCE_H
 #include <fennec/containers/sequence.h>
--- a/test/tests/containers/test_set.h
+++ b/test/tests/containers/test_set.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/containers/test_tuple.h
+++ b/test/tests/containers/test_tuple.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/core/test_event.h
+++ b/test/tests/core/test_event.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,19 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_event.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
-
 #ifndef FENNEC_TEST_CORE_EVENT_H
 #define FENNEC_TEST_CORE_EVENT_H

--- a/test/tests/lang/test_bits.h
+++ b/test/tests/lang/test_bits.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/lang/test_conditional_types.h
+++ b/test/tests/lang/test_conditional_types.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/lang/test_function.h
+++ b/test/tests/lang/test_function.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,19 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_function.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
-
 #ifndef FENNEC_TEST_LANG_FUNCTION_H
 #define FENNEC_TEST_LANG_FUNCTION_H

--- a/test/tests/lang/test_hashing.h
+++ b/test/tests/lang/test_hashing.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/lang/test_metaprogramming.h
+++ b/test/tests/lang/test_metaprogramming.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,19 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_metaprogramming.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
-
 #ifndef FENNEC_TEST_LANG_METAPROGRAMMING_H
 #define FENNEC_TEST_LANG_METAPROGRAMMING_H

--- a/test/tests/math/ext/test_quaternion.h
+++ b/test/tests/math/ext/test_quaternion.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_common.h
+++ b/test/tests/math/test_common.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_exponential.h
+++ b/test/tests/math/test_exponential.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_ext.h
+++ b/test/tests/math/test_ext.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_geometric.h
+++ b/test/tests/math/test_geometric.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_matrix.h
+++ b/test/tests/math/test_matrix.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_relational.h
+++ b/test/tests/math/test_relational.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_scalar.h
+++ b/test/tests/math/test_scalar.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_trigonometric.h
+++ b/test/tests/math/test_trigonometric.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/math/test_vector.h
+++ b/test/tests/math/test_vector.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/string/test_cstring.h
+++ b/test/tests/string/test_cstring.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/string/test_string.h
+++ b/test/tests/string/test_string.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,18 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_string.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
 #ifndef FENNEC_TEST_STRING_STRING_H
 #define FENNEC_TEST_STRING_STRING_H

--- a/test/tests/test_containers.h
+++ b/test/tests/test_containers.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_core.h
+++ b/test/tests/test_core.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,19 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_core.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
-
 #ifndef FENNEC_TEST_CORE_H
 #define FENNEC_TEST_CORE_H

--- a/test/tests/test_filesystem.h
+++ b/test/tests/test_filesystem.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_format.h
+++ b/test/tests/test_format.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,18 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_format.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
 #ifndef FENNEC_TEST_FORMAT_H
 #define FENNEC_TEST_FORMAT_H

--- a/test/tests/test_lang.h
+++ b/test/tests/test_lang.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_math.h
+++ b/test/tests/test_math.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_memory.h
+++ b/test/tests/test_memory.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec-test, a program to execute unit tests for fennec
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_platform.h
+++ b/test/tests/test_platform.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_rtti.h
+++ b/test/tests/test_rtti.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,18 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_rtti.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
 #ifndef FENNEC_TEST_RTTI_H
 #define FENNEC_TEST_RTTI_H

--- a/test/tests/test_string.h
+++ b/test/tests/test_string.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
--- a/test/tests/test_threading.h
+++ b/test/tests/test_threading.h
@@ -1,6 +1,6 @@
 // =====================================================================================================================
 //  fennec, a free and open source game engine
-//  Copyright © 2025  Medusa Slockbower
+//  Copyright © 2025 - 2026  Medusa Slockbower
 //
 //  This program is free software: you can redistribute it and/or modify
 //  it under the terms of the GNU General Public License as published by
@@ -16,19 +16,6 @@
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 // =====================================================================================================================

-///
-/// \file test_threading.h
-/// \brief
-///
-///
-/// \details
-/// \author Medusa Slockbower
-///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
-///
-///
-
-
 #ifndef FENNEC_TEST_THREADING_H
 #define FENNEC_TEST_THREADING_H