From e585e01b625fcdbc00709c1bbade1b542b1f6139 Mon Sep 17 00:00:00 2001 From: max-001 Date: Wed, 20 Nov 2024 11:42:23 +0100 Subject: Added Doxygen comments/explanation for GameObjects and Scenes --- src/doc/feature/gameobject.dox | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 src/doc/feature/gameobject.dox (limited to 'src/doc/feature/gameobject.dox') diff --git a/src/doc/feature/gameobject.dox b/src/doc/feature/gameobject.dox new file mode 100644 index 0000000..603c98d --- /dev/null +++ b/src/doc/feature/gameobject.dox @@ -0,0 +1,18 @@ +// vim:ft=doxygen +namespace crepe { +/** + +\defgroup feature_gameobject GameObjects +\ingroup feature +\brief GameObject to create a Scene + +GameObjects are the fundamental building blocks of a Scene. They represent entities +in the game world and can have various components attached to them to define their +behavior and properties. GameObjects can be created, and modified within the +Scene, allowing for a flexible and dynamic game environment. + +\see Component +\see Scene + +*/ +} -- cgit v1.2.3 From 8b5fd6188862bf9bdfc06a5419c8525d2dfd5f7f Mon Sep 17 00:00:00 2001 From: max-001 Date: Thu, 21 Nov 2024 08:53:48 +0100 Subject: Deleted comma --- src/doc/feature/gameobject.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/doc/feature/gameobject.dox') diff --git a/src/doc/feature/gameobject.dox b/src/doc/feature/gameobject.dox index 603c98d..c561874 100644 --- a/src/doc/feature/gameobject.dox +++ b/src/doc/feature/gameobject.dox @@ -8,7 +8,7 @@ namespace crepe { GameObjects are the fundamental building blocks of a Scene. They represent entities in the game world and can have various components attached to them to define their -behavior and properties. GameObjects can be created, and modified within the +behavior and properties. GameObjects can be created and modified within the Scene, allowing for a flexible and dynamic game environment. \see Component -- cgit v1.2.3