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