Changeset 88052 in vbox

Timestamp:

Mar 9, 2021 2:14:37 PM (4 years ago)

Author:

vboxsync

Message:

Audio/PDM: doxygen. bugref:9890

Location:

trunk/include/VBox/vmm

Files:

• pdmaudiohostenuminline.h (modified) (12 diffs)
• pdmaudioinline.h (modified) (2 diffs)

trunk/include/VBox/vmm/pdmaudiohostenuminline.h

@@ -48 +48 @@
 
 
-/**
- * Allocates an audio device.
+/** @defgroup grp_pdm_audio_host_enum_inline    The PDM Host Audio Enumeration Helper APIs
+ *
+ * @ingroup grp_pdm
+ * @{
+ */
+
+
+/**
+ * Allocates a host audio device for an enumeration result.
  *
  * @returns Newly allocated audio device, or NULL on failure.
@@ -57 +64 @@
  *                  after it in its private structure.
  */
-DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioDeviceAlloc(size_t cb)
+DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioHostDevAlloc(size_t cb)
 {
     AssertReturn(cb >= sizeof(PDMAUDIOHOSTDEV), NULL);
@@ -76 +83 @@
 
 /**
- * Frees an audio device allocated by PDMAudioDeviceAlloc.
+ * Frees a host audio device allocated by PDMAudioHostDevAlloc.
  *
  * @param   pDev    The device to free.  NULL is ignored.
  */
-DECLINLINE(void) PDMAudioDeviceFree(PPDMAUDIOHOSTDEV pDev)
+DECLINLINE(void) PDMAudioHostDevFree(PPDMAUDIOHOSTDEV pDev)
 {
     if (pDev)
@@ -94 +101 @@
 
 /**
- * Duplicates an audio device entry.
+ * Duplicates a host audio device enumeration entry.
  *
  * @returns Duplicated audio device entry on success, or NULL on failure.
@@ -100 +107 @@
  * @param   fOnlyCoreData
  */
-DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioDeviceDup(PPDMAUDIOHOSTDEV pDev, bool fOnlyCoreData)
+DECLINLINE(PPDMAUDIOHOSTDEV) PDMAudioHostDevDup(PPDMAUDIOHOSTDEV pDev, bool fOnlyCoreData)
 {
     AssertPtrReturn(pDev, NULL);
@@ -109 +116 @@
     AssertReturn(cbToDup >= sizeof(*pDev), NULL);
 
-    PPDMAUDIOHOSTDEV pDevDup = PDMAudioDeviceAlloc(cbToDup);
+    PPDMAUDIOHOSTDEV pDevDup = PDMAudioHostDevAlloc(cbToDup);
     if (pDevDup)
     {
@@ -154 +161 @@
             RTListNodeRemove(&pDev->Node);
 
-            PDMAudioDeviceFree(pDev);
+            PDMAudioHostDevFree(pDev);
 
             pDevEnm->cDevices--;
@@ -210 +217 @@
             || enmUsage == PDMAUDIODIR_INVALID /*all*/)
         {
-            PPDMAUDIOHOSTDEV pDstDev = PDMAudioDeviceDup(pSrcDev, fOnlyCoreData);
+            PPDMAUDIOHOSTDEV pDstDev = PDMAudioHostDevDup(pSrcDev, fOnlyCoreData);
             AssertReturn(pDstDev, VERR_NO_MEMORY);
 
@@ -279 +286 @@
 
 /** The max string length for all PDMAUDIOHOSTDEV_F_XXX.
- * @sa PDMAudioDeviceFlagsToString */
+ * @sa PDMAudioHostDevFlagsToString */
 #define PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN    (7 * 8)
 
@@ -291 +298 @@
  * @param   fFlags      Audio flags (PDMAUDIOHOSTDEV_F_XXX) to convert.
  */
-DECLINLINE(const char *) PDMAudioDeviceFlagsToString(char pszDst[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN], uint32_t fFlags)
+DECLINLINE(const char *) PDMAudioHostDevFlagsToString(char pszDst[PDMAUDIOHOSTDEV_MAX_FLAGS_STRING_LEN], uint32_t fFlags)
 {
     static const struct { const char *pszMnemonic; uint32_t cchMnemonic; uint32_t fFlag; } s_aFlags[] =
@@ -343 +350 @@
             LogFunc(("Device '%s':\n", pDev->szName));
             LogFunc(("  Usage           = %s\n",             PDMAudioDirGetName(pDev->enmUsage)));
-            LogFunc(("  Flags           = %s\n",             PDMAudioDeviceFlagsToString(szFlags, pDev->fFlags)));
+            LogFunc(("  Flags           = %s\n",             PDMAudioHostDevFlagsToString(szFlags, pDev->fFlags)));
             LogFunc(("  Input channels  = %RU8\n",           pDev->cMaxInputChannels));
             LogFunc(("  Output channels = %RU8\n",           pDev->cMaxOutputChannels));
@@ -351 +358 @@
 }
 
+/** @} */
+
 #endif /* !VBOX_INCLUDED_vmm_pdmaudiohostenuminline_h */

trunk/include/VBox/vmm/pdmaudioinline.h

@@ -48 +48 @@
 #include <iprt/string.h>
 
+
+/** @defgroup grp_pdm_audio_inline      The PDM Audio Helper APIs
+ * @ingroup grp_pdm
+ * @{
+ */
 
 /* Fix later: */
@@ -869 +874 @@
 }
 
+/** @} */
+
 #endif /* !VBOX_INCLUDED_vmm_pdmaudioinline_h */