Changeset 87170 in vbox for trunk/include/VBox

Timestamp:

Jan 4, 2021 6:44:42 PM (4 years ago)

Author:

vboxsync

Message:

pdmaudioifs.h: Use doxygen better. bugref:9882

File:

• trunk/include/VBox/vmm/pdmaudioifs.h (modified) (1 diff)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -1392 +1392 @@
      * Associated input streams then return silence when read from those.
      *
-     * Warning: Use this function carefully, as this could violate / run against the (global) VM settings. See #9882.
-     *
      * @returns VBox status code.
      * @param   pInterface      Pointer to the interface structure containing the called function pointer.
      * @param   enmDir          Audio direction to enable or disable driver for.
      * @param   fEnable         Whether to enable or disable the specified audio direction.
+     *
+     * @note    Be very careful when using this function, as this could
+     *          violate / run against the (global) VM settings.  See @bugref{9882}.
      */
     DECLR3CALLBACKMEMBER(int, pfnEnable, (PPDMIAUDIOCONNECTOR pInterface, PDMAUDIODIR enmDir, bool fEnable));