Changeset 70564 in vbox for trunk/src/VBox/Main

Timestamp:

Jan 12, 2018 6:01:25 PM (7 years ago)

Author:

vboxsync

Message:

Main/AudioDriver: Documentation.

File:

• trunk/src/VBox/Main/src-client/AudioDriver.cpp (modified) (3 diffs)

trunk/src/VBox/Main/src-client/AudioDriver.cpp

@@ -71 +71 @@
 }
 
+
+/**
+ * Initializes the audio driver with a certain (device) configuration.
+ * Note: The driver's LUN will be determined on runtime when attaching the
+ *       driver to the audio driver chain.
+ *
+ * @returns VBox status code.
+ * @param pCfg                  Audio driver configuration to use.
+ */
 int AudioDriver::Initialize(AudioDriverCfg *pCfg)
 {
@@ -85 +94 @@
  * Does nothing if the audio driver already is attached.
  *
- * @returns IPRT status code.
+ * @returns VBox status code.
  * @param   pThis               Audio driver to detach.
  */
@@ -134 +143 @@
  * Does nothing if the audio driver already is detached or not attached.
  *
- * @returns IPRT status code.
+ * @returns VBox status code.
  * @param   pThis               Audio driver to detach.
  */