aboutsummaryrefslogtreecommitdiff
path: root/src/doc/feature/bgm.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-09 15:46:30 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-09 15:46:30 +0100
commitf3a30b93aa76f546144c744a08a4ed04bef95192 (patch)
tree3c4a62e7b7affb8b6f9b48e9ca8621e020c55e8b /src/doc/feature/bgm.dox
parente8e5412965f19d3966635a2c207d55ae1b12db51 (diff)
more WIP doxygen
Diffstat (limited to 'src/doc/feature/bgm.dox')
-rw-r--r--src/doc/feature/bgm.dox22
1 files changed, 22 insertions, 0 deletions
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
+
+*/
+}