Changeset 19959 in vbox

Timestamp:

May 24, 2009 3:08:12 AM (15 years ago)

Author:

vboxsync

Message:

pdmifs.h: r=bird: added todos.

File:

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

trunk/include/VBox/pdmifs.h

@@ -167 +167 @@
     /** PDMISCSICONNECTOR       - The SCSI command execution connector interface (Up) Coupled with PDMINTERFACE_SCSI_PORT. */
     PDMINTERFACE_SCSI_CONNECTOR,
-    /** PDMDDISPLAYVBVACALLBACKS       - The Display VBVA call-backs */
+    /** PDMDDISPLAYVBVACALLBACKS - The Display VBVA callbacks. */
     PDMINTERFACE_DISPLAY_VBVA_CALLBACKS,
 
@@ -427 +427 @@
 } PDMIDISPLAYPORT;
 
-typedef struct _VBOXVHWACMD *PVBOXVHWACMD;
+
+typedef struct _VBOXVHWACMD *PVBOXVHWACMD; /**< @todo r=bird: _VBOXVHWACMD -> VBOXVHWACMD; avoid using 1 or 2 leading underscores. Also, a line what it is to make doxygen happy. */
 
 /** Pointer to a display connector interface. */
@@ -2601 +2602 @@
 typedef struct PDMDDISPLAYVBVACALLBACKS *PPDMDDISPLAYVBVACALLBACKS;
 /**
- * Display VBVA callbacks
+ * Display VBVA callbacks.
  */
 typedef struct PDMDDISPLAYVBVACALLBACKS
 {
-    /**
-     * Informs guest about completion of processing the given Video HW Acceleration command,
-     * does not wait for the guest to process the command
+
+    /**
+     * Informs guest about completion of processing the given Video HW Acceleration
+     * command, does not wait for the guest to process the command.
+     *
+     * @returns ???
+     * @param   pInterface          Pointer to this interface.
+     * @param   pCmd                The Video HW Acceleration Command that was
+     *                              completed.
+     * @todo r=bird: if asynch mean asyncronous; then
+     *                   s/pfnVHWACommandCompleteAsynch/pfnVHWACommandCompleteAsync/;
+     *               fi
      */
     DECLR3CALLBACKMEMBER(int, pfnVHWACommandCompleteAsynch, (PPDMDDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd));
-}PDMDDISPLAYVBVACALLBACKS;
+
+} PDMDDISPLAYVBVACALLBACKS;
 
 /** @} */