Changeset 89800 in vbox for trunk/src

Timestamp:

Jun 21, 2021 12:02:14 AM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

145257

Message:

pdmaudioifs.h,AudioMix*h: Documentation. bugref:9890

Location:

trunk/src/VBox/Devices/Audio

Files:

• AudioMixBuffer.h (modified) (2 diffs)
• AudioMixer.h (modified) (2 diffs)

trunk/src/VBox/Devices/Audio/AudioMixBuffer.h

@@ -24 +24 @@
 #include <iprt/cdefs.h>
 #include <VBox/vmm/pdmaudioifs.h>
+
+/** @defgroup grp_pdm_ifs_audio_mixer_buffers   Audio Mixing Buffers
+ * @ingroup grp_pdm_ifs_audio_mixing
+ *
+ * @note This is currently placed under PDM Audio Interface as that seemed like
+ *       the best place for it.
+ *
+ * @{
+ */
 
 
@@ -229 +238 @@
 /** @} */
 
+/** @} */
 #endif /* !VBOX_INCLUDED_SRC_Audio_AudioMixBuffer_h */
 

trunk/src/VBox/Devices/Audio/AudioMixer.h

@@ -32 +32 @@
 #include "AudioHlp.h"
 
+
+/** @defgroup grp_pdm_ifs_audio_mixing  Audio Mixing
+ * @ingroup grp_pdm_ifs_audio
+ *
+ * @note This is currently placed under PDM Audio Interface as that seemed like
+ *       the best place for it.
+ *
+ * @{
+ */
 
 /** Pointer to an audio mixer sink. */
@@ -325 +334 @@
 /** @} */
 
+/** @} */
+
 #endif /* !VBOX_INCLUDED_SRC_Audio_AudioMixer_h */