Changeset 90837 in vbox

Timestamp:

Aug 24, 2021 11:33:12 AM (4 years ago)

Author:

vboxsync

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

146472

Message:

VMM: Doxygen fixes.

Location:

trunk/include/VBox

Files:

• dbg.h (modified) (1 diff)
• vmm/pdmblkcache.h (modified) (6 diffs)
• vusb.h (modified) (1 diff)

trunk/include/VBox/dbg.h

@@ -1065 +1065 @@
  *
  * @returns VBox status.
- * @param   pCmd        Pointer to the command descriptor (as registered).
+ * @param   pFunc       Pointer to the function descriptor (as registered).
  * @param   pCmdHlp     Pointer to command helper functions.
  * @param   pUVM        The user mode VM handle, can in theory be NULL.

trunk/include/VBox/vmm/pdmblkcache.h

@@ -106 +106 @@
  * Completion callback for devices.
  *
- * @param   pDrvIns         The device instance.
+ * @param   pDevIns         The device instance.
  * @param   pvUser          User argument given during request initiation.
  * @param   rc              The status code of the completed request.
@@ -132 +132 @@
  * Discard enqueue callback for devices.
  *
- * @param   pDrvIns         The driver instance.
+ * @param   pDevIns         The device instance.
  * @param   paRanges        Ranges to discard.
  * @param   cRanges         Number of range entries.
@@ -154 +154 @@
 
 /**
- * I/O enqueue callback for drivers.
- *
- * @param   pDrvIns         The driver instance.
+ * I/O enqueue callback for internal users.
+ *
+ * @param   pvUser          User data.
  * @param   enmXferDir      Transfer direction.
  * @param   off             Transfer offset.
@@ -171 +171 @@
  * Discard enqueue callback for VMM internal users.
  *
- * @param   pDrvIns         The driver instance.
+ * @param   pvUser          User data.
  * @param   paRanges        Ranges to discard.
  * @param   cRanges         Number of range entries.
@@ -182 +182 @@
 
 /**
- * Completion callback for USB.
- *
- * @param   pDrvIns         The driver instance.
+ * Completion callback for USB devices.
+ *
+ * @param   pUsbIns         The USB device instance.
  * @param   pvUser          User argument given during request initiation.
  * @param   rc              The status code of the completed request.
@@ -193 +193 @@
 
 /**
- * I/O enqueue callback for drivers.
- *
- * @param   pDrvIns         The driver instance.
+ * I/O enqueue callback for USB devices.
+ *
+ * @param   pUsbIns         The USB device instance.
  * @param   enmXferDir      Transfer direction.
  * @param   off             Transfer offset.

trunk/include/VBox/vusb.h

@@ -931 +931 @@
  * This is called by the reset thread when the reset has been completed.
  *
- * @param   pDev        Pointer to the virtual USB device core.
+ * @param   pDevice Pointer to the virtual USB device core.
  * @param   rc      The VBox status code of the reset operation.
- * @param   pvUser      User specific argument.
+ * @param   pvUser  User specific argument.
  *
  * @thread  The reset thread or EMT.