From 41f9352ec236bbd0035644d983d9a2402bb8326f Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 3 Dec 2024 20:47:44 +0100 Subject: wrap lines --- src/doc/feature/scene.dox | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) (limited to 'src/doc') 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 -- cgit v1.2.3 From f137451d0edb13543919cf2d1a3af379cb3a1485 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 3 Dec 2024 21:14:53 +0100 Subject: update feature listing --- src/doc/features.dox | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'src/doc') diff --git a/src/doc/features.dox b/src/doc/features.dox index 4786bed..96b7c6c 100644 --- a/src/doc/features.dox +++ b/src/doc/features.dox @@ -1,10 +1,28 @@ // vim:ft=doxygen /** +\htmlonly + +\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
\copybrief feature_script + +- Game flow management + - \ref feature_scene
\copybrief feature_scene + +- Entity + - \ref feature_gameobject
\copybrief feature_gameobject + */ -- cgit v1.2.3 From 0fa167fa3ee78f1e5379888114890c6a92cdaa25 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 4 Dec 2024 13:01:22 +0100 Subject: use doxygen `\n` instead of html --- src/doc/features.dox | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/doc') diff --git a/src/doc/features.dox b/src/doc/features.dox index 96b7c6c..21a040a 100644 --- a/src/doc/features.dox +++ b/src/doc/features.dox @@ -17,12 +17,12 @@ feature. \par Features - Scripting - - \ref feature_script
\copybrief feature_script + - \ref feature_script \n\copybrief feature_script - Game flow management - - \ref feature_scene
\copybrief feature_scene + - \ref feature_scene \n\copybrief feature_scene - Entity - - \ref feature_gameobject
\copybrief feature_gameobject + - \ref feature_gameobject \n\copybrief feature_gameobject */ -- cgit v1.2.3 From 210800c5fa71460d9cbcfff808a62cc07e0fdb7a Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 4 Dec 2024 14:01:01 +0100 Subject: fix namespace type references + update contributing.md --- Doxyfile | 4 ++-- contributing.md | 15 +++++++++++---- src/doc/index.dox | 7 +++++++ src/doc/layout.xml | 10 +++++----- src/doc/style.css | 6 +++--- 5 files changed, 28 insertions(+), 14 deletions(-) (limited to 'src/doc') diff --git a/Doxyfile b/Doxyfile index f2714cd..07c86d1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -17,11 +17,10 @@ GENERATE_LATEX = NO LAYOUT_FILE = src/doc/layout.xml TAB_SIZE = 2 -HTML_INDEX_NUM_ENTRIES = 2 +HTML_INDEX_NUM_ENTRIES = 999 HTML_EXTRA_STYLESHEET = src/doc/style.css SHOW_HEADERFILE = NO -USE_MDFILE_AS_MAINPAGE = ./readme.md REPEAT_BRIEF = NO EXTRACT_STATIC = YES @@ -29,6 +28,7 @@ HIDE_UNDOC_NAMESPACES = YES HIDE_UNDOC_CLASSES = YES QUIET = YES +WARNINGS = NO # set these to NO for user-only docs INTERNAL_DOCS = YES diff --git a/contributing.md b/contributing.md index 9f22c60..7dedaa7 100644 --- a/contributing.md +++ b/contributing.md @@ -983,18 +983,25 @@ following format: - A **minimal** example to demonstrate how the feature is used. The example should be written such that the following is clear to the reader: - Which headers need to be included to utilize the feature + - *Why* the example works, not what is happening in the example - Where is this code supposed to be called (e.g. inside scene/script functions) - - *Why* the example works, not what is happening in the example - Which restrictions should be kept in mind (e.g. copy/move semantics, max component instances, speed considerations) Features should be documented as clear and concise as possible, so the following points should be kept in mind: -- If a page expands on an example from another page, directly reference the - other page using a cross-reference (`\ref`) instead of writing a larger - example +-
+ If a page expands on an example from another page, directly reference the + other page using a cross-reference (`\ref`) in a `\note` block at the top of + the page. + + + ``` + \note This page builds on top of the example shown in \ref feature_script + ``` +
- When explaining the usage of specific functions, qualify them such that Doxygen is able to add a cross-reference or manually add a reference using the `\ref` command. 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 @@ - + @@ -56,10 +56,10 @@ - - + + @@ -102,11 +102,12 @@ + - + @@ -119,7 +120,6 @@ - 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; } -- cgit v1.2.3