From 0cf6b64538c34cbbb1fe582421487ffd2b842f24 Mon Sep 17 00:00:00 2001
From: robojumper <robojumper@gmail.com>
Date: Tue, 3 Jun 2025 00:39:44 +0200
Subject: [PATCH] Small docs

---
 include/d/snd/d_snd_mgr.h        | 1 +
 include/d/snd/d_snd_player_mgr.h | 4 ++++
 include/d/snd/d_snd_source.h     | 5 ++++-
 include/d/snd/d_snd_source_if.h  | 1 +
 include/toBeSorted/music_mgrs.h  | 1 +
 5 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/include/d/snd/d_snd_mgr.h b/include/d/snd/d_snd_mgr.h
index d5606784..305e96ea 100644
--- a/include/d/snd/d_snd_mgr.h
+++ b/include/d/snd/d_snd_mgr.h
@@ -4,6 +4,7 @@
 #include "egg/audio/eggAudioMgr.h"
 #include "nw4r/snd/snd_SoundArchivePlayer.h"
 
+/** The core audio manager used for most sounds. */
 class dSndMgr_c : public EGG::SimpleAudioMgr {
 public:
     dSndMgr_c();
diff --git a/include/d/snd/d_snd_player_mgr.h b/include/d/snd/d_snd_player_mgr.h
index 26026b10..f80a07af 100644
--- a/include/d/snd/d_snd_player_mgr.h
+++ b/include/d/snd/d_snd_player_mgr.h
@@ -10,6 +10,10 @@
 class dSndPlayerMgr_c;
 extern template class SndMgrDisposer<dSndPlayerMgr_c>;
 
+/**
+ * The main interface for managing sound stuff. Will delegate to dSndMgr_c for
+ * most things, but handles demo (cutscene) sound effects (SE_DEMO*) by itself.
+ */
 class dSndPlayerMgr_c {
 public:
     SndMgrDisposer<dSndPlayerMgr_c> *GetDisposer() {
diff --git a/include/d/snd/d_snd_source.h b/include/d/snd/d_snd_source.h
index 64a3eaad..d732e924 100644
--- a/include/d/snd/d_snd_source.h
+++ b/include/d/snd/d_snd_source.h
@@ -6,6 +6,7 @@
 #include "d/snd/d_snd_source_if.h"
 #include "nw4r/ut/ut_list.h"
 
+/** Manages sound relating to a particular actor. */
 class dSoundSource_c : public dSoundSourceIf_c, public dSnd3DActor_c {
 public:
     dSoundSource_c(u8, dAcBase_c *, UNKWORD, UNKWORD);
@@ -52,7 +53,9 @@ public:
     virtual void d_s_vt_0x1E4();
     virtual void d_s_vt_0x1E8();
 
-    // Overrides of dSoundSourceIf_c
+    // Overrides of dSoundSourceIf_c - always in the first section of
+    // the vtable, so the order is not certain. May have to reorder for weak
+    // function order.
 
     virtual const nw4r::math::VEC3 &getListenerPosition() const override;
 
diff --git a/include/d/snd/d_snd_source_if.h b/include/d/snd/d_snd_source_if.h
index 32973df0..8a77ff67 100644
--- a/include/d/snd/d_snd_source_if.h
+++ b/include/d/snd/d_snd_source_if.h
@@ -6,6 +6,7 @@
 
 class dAcBase_c;
 
+/** An abstract interface for sound relating to a particular actor. */
 class dSoundSourceIf_c {
 public:
     virtual ~dSoundSourceIf_c() {}
diff --git a/include/toBeSorted/music_mgrs.h b/include/toBeSorted/music_mgrs.h
index b394ceaa..fd498ac8 100644
--- a/include/toBeSorted/music_mgrs.h
+++ b/include/toBeSorted/music_mgrs.h
@@ -28,6 +28,7 @@ extern "C" void fn_80364FD0(void *, s32);
 extern "C" bool fn_80364DA0(void *);
 extern "C" void fn_80364D00(void *, s32);
 
+// ENEMY_BGM_RELATED_MGR -> dSndSourceMgr_c
 extern "C" void *ENEMY_BGM_RELATED_MGR;
 extern "C" void fn_80384570(void *, bool);
 extern "C" void fn_803858D0(void *);