- 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/include/fennec/platform/interface/display_server.h
+++ b/include/fennec/platform/interface/display_server.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file display_server.h
+/// \file fennec/platform/interface/display_server.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

@@ -157,10 +157,8 @@ protected:
 	featureset_t           features;    //!< the feature set of the display server
 	unique_ptr<gfxcontext> gfx_context; //!< the graphics context of the display server

-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE() {
 	}
-#endif
 };

 ///
--- a/include/fennec/platform/interface/fwd.h
+++ b/include/fennec/platform/interface/fwd.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/include/fennec/platform/interface/platform.h
+++ b/include/fennec/platform/interface/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/include/fennec/platform/interface/window.h
+++ b/include/fennec/platform/interface/window.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file window.h
+/// \file fennec/platform/interface/window.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/platform.h
+++ b/include/fennec/platform/linux/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
@@ -33,10 +33,8 @@ public:
 	void initialize() override; //!< platform initialization
 	void shutdown() override;   //!< platform shutdown

-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE(unix_platform) {
 	}
-#endif
 };

 }
--- a/include/fennec/platform/linux/wayland/egl/context.h
+++ b/include/fennec/platform/linux/wayland/egl/context.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file context.h
+/// \file fennec/platform/linux/wayland/egl/context.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

@@ -54,11 +54,9 @@ public:
 	gfxsurface* create_surface(window* window) override;

 private:
-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE(eglcontext) {
 		wayland_server::ctx_registry::register_type<wayland_eglcontext>();
 	}
-#endif
 };

 }
--- a/include/fennec/platform/linux/wayland/egl/surface.h
+++ b/include/fennec/platform/linux/wayland/egl/surface.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file surface.h
+/// \file fennec/platform/linux/wayland/egl/surface.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/wayland/fwd.h
+++ b/include/fennec/platform/linux/wayland/fwd.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file fwd.h
+/// \file fennec/platform/linux/wayland/fwd.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/wayland/lib/loader.h
+++ b/include/fennec/platform/linux/wayland/lib/loader.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/include/fennec/platform/linux/wayland/lib/sym.h
+++ b/include/fennec/platform/linux/wayland/lib/sym.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/include/fennec/platform/linux/wayland/lib/wayland.h
+++ b/include/fennec/platform/linux/wayland/lib/wayland.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/include/fennec/platform/linux/wayland/libdecor/libdecor.h
+++ b/include/fennec/platform/linux/wayland/libdecor/libdecor.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file libdecor.h
+/// \file fennec/platform/linux/wayland/libdecor/libdecor.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/wayland/libdecor/loader.h
+++ b/include/fennec/platform/linux/wayland/libdecor/loader.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file loader.h
+/// \file fennec/platform/linux/wayland/libdecor/loader.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/wayland/libdecor/sym.h
+++ b/include/fennec/platform/linux/wayland/libdecor/sym.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/include/fennec/platform/linux/wayland/server.h
+++ b/include/fennec/platform/linux/wayland/server.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file server.h
+/// \file fennec/platform/linux/wayland/server.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

@@ -109,11 +109,9 @@ private:
 	static void _libdecor_on_error(struct libdecor*, libdecor_error error, const char* message);
 #endif

-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE(display_server) {
 		display_server::register_type<wayland_server>(1);
 	}
-#endif

 	friend class wayland_window;
 };
--- a/include/fennec/platform/linux/wayland/window.h
+++ b/include/fennec/platform/linux/wayland/window.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file window.h
+/// \file fennec/platform/linux/wayland/window.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/linux/xkb/lib/loader.h
+++ b/include/fennec/platform/linux/xkb/lib/loader.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/include/fennec/platform/linux/xkb/lib/sym.h
+++ b/include/fennec/platform/linux/xkb/lib/sym.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/include/fennec/platform/linux/xkb/lib/xkb.h
+++ b/include/fennec/platform/linux/xkb/lib/xkb.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/include/fennec/platform/opengl/egl/context.h
+++ b/include/fennec/platform/opengl/egl/context.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file context.h
+/// \file fennec/platform/opengl/egl/context.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

@@ -61,10 +61,8 @@ private:
 	EGLint _eglvmajor, _eglvminor, _eglctype;
 	cstring _extensions;

-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE(glcontext) {
 	}
-#endif

 	friend class eglsurface;
 };
--- a/include/fennec/platform/opengl/egl/error.h
+++ b/include/fennec/platform/opengl/egl/error.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file error.h
+/// \file fennec/platform/opengl/egl/error.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/opengl/egl/fwd.h
+++ b/include/fennec/platform/opengl/egl/fwd.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file fwd.h
+/// \file fennec/platform/opengl/egl/fwd.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/opengl/egl/surface.h
+++ b/include/fennec/platform/opengl/egl/surface.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file surface.h
+/// \file fennec/platform/opengl/egl/surface.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///

--- a/include/fennec/platform/unix/platform.h
+++ b/include/fennec/platform/unix/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
@@ -51,10 +51,8 @@ public:
 	symbol find_symbol(shared_object* obj, const cstring& name) override;

 private:
-#ifndef FENNEC_DOXYGEN
 	FENNEC_RTTI_CLASS_ENABLE(platform) {
 	}
-#endif
 };

 }
--- a/include/fennec/platform/window_manager.h
+++ b/include/fennec/platform/window_manager.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
@@ -17,14 +17,14 @@
 // =====================================================================================================================

 ///
-/// \file window_manager.h
+/// \file fennec/platform/window_manager.h
 /// \brief
 ///
 ///
 /// \details
 /// \author Medusa Slockbower
 ///
-/// \copyright Copyright © 2025 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
+/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
 ///
 ///