aboutsummaryrefslogtreecommitdiff
path: root/src/doc/feature/sfx.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/sfx.dox
parente8e5412965f19d3966635a2c207d55ae1b12db51 (diff)
more WIP doxygen
Diffstat (limited to 'src/doc/feature/sfx.dox')
-rw-r--r--src/doc/feature/sfx.dox24
1 files changed, 24 insertions, 0 deletions
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
+
+*/
+}