From f3a30b93aa76f546144c744a08a4ed04bef95192 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Mon, 9 Dec 2024 15:46:30 +0100
Subject: more WIP doxygen

---
 src/doc/feature/bgm.dox        | 22 ++++++++++++++++++++++
 src/doc/feature/gameobject.dox |  4 ++--
 src/doc/feature/proxy.dox      |  7 ++++++-
 src/doc/feature/sfx.dox        | 24 ++++++++++++++++++++++++
 4 files changed, 54 insertions(+), 3 deletions(-)
 create mode 100644 src/doc/feature/bgm.dox
 create mode 100644 src/doc/feature/sfx.dox

(limited to 'src/doc/feature')

diff --git a/src/doc/feature/bgm.dox b/src/doc/feature/bgm.dox
new file mode 100644
index 0000000..968abb8
--- /dev/null
+++ b/src/doc/feature/bgm.dox
@@ -0,0 +1,22 @@
+// vim:ft=doxygen
+namespace crepe {
+/**
+
+\defgroup feature_bgm Playing background music
+\ingroup feature
+\brief Add background music to a scene using the AudioSource component
+
+This page shows how to implement background music using the AudioSource
+effects.
+
+\see AudioSource
+
+\par Example
+
+\note This example assumes you already have a GameObject. If not, read
+\"\ref feature_gameobject\" first.
+
+\todo Merge #60
+
+*/
+}
diff --git a/src/doc/feature/gameobject.dox b/src/doc/feature/gameobject.dox
index c561874..ac3927c 100644
--- a/src/doc/feature/gameobject.dox
+++ b/src/doc/feature/gameobject.dox
@@ -2,9 +2,9 @@
 namespace crepe {
 /**
 
-\defgroup feature_gameobject GameObjects
+\defgroup feature_gameobject Entity basics
 \ingroup feature
-\brief GameObject to create a Scene
+\brief Building game entities using a GameObject
 
 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
diff --git a/src/doc/feature/proxy.dox b/src/doc/feature/proxy.dox
index 02ed4a5..66bbd2f 100644
--- a/src/doc/feature/proxy.dox
+++ b/src/doc/feature/proxy.dox
@@ -6,7 +6,9 @@ namespace crepe {
 \ingroup feature
 \brief Use ValueBroker as if it were a regular variable
 
-\todo Long description
+Proxy provides operators that allow you to use a ValueBroker instance as if it
+were a regular variable. Proxy implements a constructor that allows it to be
+used as a substitute return type for any function that returns ValueBroker.
 
 \see ValueBroker
 \see Proxy
@@ -30,6 +32,9 @@ void anywhere() {
 
 	// implicitly calls .get()
 	int out = calculation(foo);
+
+	// explicitly cast (also calls .get())
+	int casted = int(foo);
 }
 
 ```
diff --git a/src/doc/feature/sfx.dox b/src/doc/feature/sfx.dox
new file mode 100644
index 0000000..2a5c9cc
--- /dev/null
+++ b/src/doc/feature/sfx.dox
@@ -0,0 +1,24 @@
+// vim:ft=doxygen
+namespace crepe {
+/**
+
+\defgroup feature_sfx Playing sound effects
+\ingroup feature
+\brief Fire a sound effect using the AudioSource component
+
+This page shows how to implement one-shot sound effects using the AudioSource
+component's 'fire and forget'-style API.
+
+\see AudioSource
+
+\par Example
+
+\note This example assumes you already have a GameObject to attach the
+AudioSource component to, and uses a Script to control the AudioSource instance.
+Separate pages describing these features in more detail can be found at \"\ref
+feature_gameobject\" and \"\ref feature_script\" respectively.
+
+\todo Merge #60
+
+*/
+}
-- 
cgit v1.2.3