diff options
| author | WBoerenkamps <wrj.boerenkamps@student.avans.nl> | 2024-12-04 21:50:45 +0100 | 
|---|---|---|
| committer | WBoerenkamps <wrj.boerenkamps@student.avans.nl> | 2024-12-04 21:50:45 +0100 | 
| commit | d941f497c10bb9146bb83c5c4e59e844d0641a04 (patch) | |
| tree | 7dfdf691175caf8e43a9c7a7e07a1cdd6bfed0ff /src/doc | |
| parent | d10f220ff6c5d62bb51793a0ef4ee37090161d89 (diff) | |
| parent | cfb67ffddb9f4bb0357c2b9df4239bfee7364c5a (diff) | |
merge master
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/feature/scene.dox | 41 | ||||
| -rw-r--r-- | src/doc/features.dox | 18 | ||||
| -rw-r--r-- | src/doc/index.dox | 7 | ||||
| -rw-r--r-- | src/doc/layout.xml | 10 | ||||
| -rw-r--r-- | src/doc/style.css | 6 | 
5 files changed, 57 insertions, 25 deletions
diff --git a/src/doc/feature/scene.dox b/src/doc/feature/scene.dox index d81df4c..4124e37 100644 --- a/src/doc/feature/scene.dox +++ b/src/doc/feature/scene.dox @@ -6,10 +6,11 @@ namespace crepe {  \ingroup feature  \brief User-defined scenes -Scenes can be used to implement game environments, and allow arbitrary game objects to be organized -as part of the game structure. Scenes are implemented as derivative classes of Scene, which are -added to the game using the SceneManager. Scenes describe the start of a Scene and cannot modify -GameObjects during runtime of a Scene (use \ref feature_script "Scripting" for this purpose). +Scenes can be used to implement game environments, and allow arbitrary game +objects to be organized as part of the game structure. Scenes are implemented as +derivative classes of Scene, which are added to the game using the SceneManager. +Scenes describe the start of a Scene and cannot modify GameObjects during +runtime of a Scene (use \ref feature_script for this purpose).  \see SceneManager  \see GameObject @@ -18,19 +19,25 @@ GameObjects during runtime of a Scene (use \ref feature_script "Scripting" for t  \par Example -This example demonstrates how to define and add scenes to the loop/scene manager in the `crepe` framework. -Each concrete scene should be derived from Scene. In the example below, the concrete scene is named MyScene. -A concrete scene should, at least, implement (override) two methods, namely load_scene() and get_name(). The -scene is build (using GameObjects) in the load_scene() method. GameObjects should be made using the -component_manager::new_object(). In the example below, two GameObjects (named object1 and object2) are added -to MyScene. object1 and object2 do not have any non-default Components attached to them, however, if needed, -this should also be done in load_scene(). Each concrete scene must have a unique name. This unique name is -used to load a new concrete scene (via a Script). The unique name is set using the get_name() method. In the -example below, MyScene's unique name is my_scene. -After setting up one or more concrete scene(s), the concrete scene(s) should be added to the loop/scene manager. -This is done in your main(). Firstly, the LoopManager should be instantiated. Than, all the concrete scene(s) -should be added to the loop/scene manger via loop_mgr::add_scene<>(). The templated argument should define the -concrete scene to be added. +This example demonstrates how to define and add scenes to the loop/scene manager +in the `crepe` framework. Each concrete scene should be derived from Scene. In +the example below, the concrete scene is named MyScene. A concrete scene should, +at least, implement (override) two methods, namely load_scene() and get_name(). +The scene is build (using GameObjects) in the load_scene() method. GameObjects +should be made using the component_manager::new_object(). + +In the example below, two GameObjects (named object1 and object2) are added to +MyScene. object1 and object2 do not have any non-default Components attached to +them, however, if needed, this should also be done in load_scene(). Each +concrete scene must have a unique name. This unique name is used to load a new +concrete scene (via a Script). The unique name is set using the get_name() +method. In the example below, MyScene's unique name is my_scene. + +After setting up one or more concrete scene(s), the concrete scene(s) should be +added to the loop/scene manager. This is done in your main(). Firstly, the +LoopManager should be instantiated. Than, all the concrete scene(s) should be +added to the loop/scene manger via loop_mgr::add_scene<>(). The templated +argument should define the concrete scene to be added.  ```cpp  #include <crepe/api/LoopManager.h> diff --git a/src/doc/features.dox b/src/doc/features.dox index 4786bed..21a040a 100644 --- a/src/doc/features.dox +++ b/src/doc/features.dox @@ -1,10 +1,28 @@  // vim:ft=doxygen  /** +\htmlonly +<style> +table.memberdecls { display: none; } +ul { margin: 1ex 0pt; } +</style> +\endhtmlonly +  \defgroup feature Features  \brief Engine components  This page lists engine features and contains usage instructions for each  feature. +\par Features + +- Scripting +	- \ref feature_script \n\copybrief feature_script + +- Game flow management +	- \ref feature_scene \n\copybrief feature_scene + +- Entity +	- \ref feature_gameobject \n\copybrief feature_gameobject +  */ diff --git a/src/doc/index.dox b/src/doc/index.dox index 5ec7889..7796f34 100644 --- a/src/doc/index.dox +++ b/src/doc/index.dox @@ -8,3 +8,10 @@ Welcome to the documentation for the crêpe game engine.  \see feature  */ + +/** + +\namespace crepe +\brief Engine namespace + +*/ diff --git a/src/doc/layout.xml b/src/doc/layout.xml index fb4cc0c..6336655 100644 --- a/src/doc/layout.xml +++ b/src/doc/layout.xml @@ -11,7 +11,7 @@  			<tab type="modulelist" visible="yes" title="" intro=""/>  			<tab type="modulemembers" visible="yes" title="" intro=""/>  		</tab> -		<tab type="namespaces" visible="no" title=""> +		<tab type="namespaces" visible="yes" title="">  			<tab type="namespacelist" visible="yes" title="" intro=""/>  			<tab type="namespacemembers" visible="yes" title="" intro=""/>  		</tab> @@ -56,10 +56,10 @@  			<interfaces title=""/>  			<publicslots title=""/>  			<signals title=""/> -			<publicmethods title=""/> -			<publicstaticmethods title=""/>  			<publicattributes title=""/>  			<publicstaticattributes title=""/> +			<publicmethods title=""/> +			<publicstaticmethods title=""/>  			<protectedtypes title=""/>  			<protectedslots title=""/>  			<protectedmethods title=""/> @@ -102,11 +102,12 @@  	</class>  	<namespace>  		<briefdescription visible="yes"/> +		<detaileddescription title=""/>  		<memberdecl>  			<nestednamespaces visible="yes" title=""/>  			<constantgroups visible="yes" title=""/>  			<interfaces visible="yes" title=""/> -			<classes visible="yes" title=""/> +			<classes visible="no" title=""/>  			<concepts visible="yes" title=""/>  			<structs visible="yes" title=""/>  			<exceptions visible="yes" title=""/> @@ -119,7 +120,6 @@  			<properties title=""/>  			<membergroups visible="yes"/>  		</memberdecl> -		<detaileddescription title=""/>  		<memberdef>  			<inlineclasses title=""/>  			<typedefs title=""/> diff --git a/src/doc/style.css b/src/doc/style.css index daabd39..c12240c 100644 --- a/src/doc/style.css +++ b/src/doc/style.css @@ -1,6 +1,6 @@  #titlearea, -address { -	display: none; -} +address, +a[href="namespaces.html"] +{ display: none; }  h2.groupheader { margin-top: revert; }  |