Changeset 63716 in vbox

Timestamp:

Sep 5, 2016 3:08:07 PM (8 years ago)

Author:

vboxsync

Message:

Docs.

File:

• trunk/include/VBox/vmm/pdmaudioifs.h (modified) (3 diffs)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -868 +868 @@
 
     /**
-     *  @todo Docs!
+     * Retrieves the current status of the host audio backend.
+     *
+     * @returns Status of the host audio backend.
+     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
+     * @param   enmDir          Audio direction to check host audio backend for. Specify PDMAUDIODIR_ANY for the overall
+     *                          backend status.
      */
     DECLR3CALLBACKMEMBER(PDMAUDIOBACKENDSTS, pfnGetStatus, (PPDMIAUDIOCONNECTOR pInterface, PDMAUDIODIR enmDir));
@@ -1045 +1050 @@
 {
     /**
-     * Initialize the host-specific audio device.
+     * Initializes the host backend (driver).
      *
      * @returns VBox status code.
@@ -1053 +1058 @@
 
     /**
-     * Shuts down the host-specific audio device.
+     * Shuts down the host backend (driver).
      *
      * @returns VBox status code.