Changeset 64294 in vbox for trunk/src

Timestamp:

Oct 17, 2016 11:34:36 AM (8 years ago)

Author:

vboxsync

Message:

VUSB: Doxygen fixes

Location:

trunk/src/VBox/Devices/USB

Files:

• DevOHCI.cpp (modified) (3 diffs)
• DrvVUSBRootHub.cpp (modified) (2 diffs)
• VUSBDevice.cpp (modified) (3 diffs)
• VUSBSniffer.cpp (modified) (2 diffs)
• VUSBUrb.cpp (modified) (1 diff)
• darwin/USBProxyDevice-darwin.cpp (modified) (1 diff)
• linux/USBProxyDevice-linux.cpp (modified) (4 diffs)
• os2/USBProxyDevice-os2.cpp (modified) (2 diffs)

trunk/src/VBox/Devices/USB/DevOHCI.cpp

@@ -3208 +3208 @@
  * @returns true on success.
  * @returns false on failure to submit.
+ * @param   pThis   The OHCI controller instance data.
+ * @param   pITd    The transfer descriptor to service.
+ * @param   ITdAddr The address of the transfer descriptor in gues memory.
  * @param   R       The start packet (frame) relative to the start of frame in HwInfo.
+ * @param   pEd     The OHCI endpoint descriptor.
+ * @param   EdAddr  The endpoint descriptor address in guest memory.
  */
 static bool ohciServiceIsochronousTd(POHCI pThis, POHCIITD pITd, uint32_t ITdAddr, const unsigned R, PCOHCIED pEd, uint32_t EdAddr)
@@ -4118 +4123 @@
 }
 
-/**
- * @interface_method_impl{VUSBIROOTHUBPORT,pfnFramerateChanged}.
- */
+/** @interface_method_impl{VUSBIROOTHUBPORT,pfnFrameRateChanged} */
 static DECLCALLBACK(void) ohciR3FrameRateChanged(PVUSBIROOTHUBPORT pInterface, uint32_t u32FrameRate)
 {
@@ -5524 +5527 @@
  * @param   pDevIns     The device instance.
  * @param   pSSM        The handle to the saved state.
- * @param   u32Version  The data unit version number.
  */
 static DECLCALLBACK(int) ohciR3LoadPrep(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)

trunk/src/VBox/Devices/USB/DrvVUSBRootHub.cpp

@@ -95 +95 @@
  * but passes it down the device.
  *
- * @subsection subsec_dev_vusb_urb_bulk  Isochronous
+ * @subsection subsec_dev_vusb_urb_isoc  Isochronous
  *
  * This kind of transfers hasn't yet been implemented.
@@ -917 +917 @@
 
 
-/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnSetFrameProcessing} */
+/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnSetPeriodicFrameProcessing} */
 static DECLCALLBACK(int) vusbRhSetFrameProcessing(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uFrameRate)
 {

trunk/src/VBox/Devices/USB/VUSBDevice.cpp

@@ -1151 +1151 @@
  * before detaching a device.
  *
+ * @returns nothing.
+ * @param   pDev        The VUSB device instance.
  * @param   fDetaching  If set, we will unconditionally unlink (and leak)
  *                      any URBs which isn't reaped.
@@ -1433 +1435 @@
  * @returns VBox status code.
  *
- * @param   pDev            Pointer to the VUSB device interface.
+ * @param   pDevice         Pointer to the VUSB device interface.
  * @param   fResetOnLinux   Whether it's safe to reset the device(s) on a linux
  *                          host system. See discussion of logical reconnects elsewhere.
  * @param   pfnDone         Pointer to the completion routine. If NULL a synchronous
  *                          reset is preformed not respecting the 10ms.
+ * @param   pvUser          Opaque user data to pass to the done callback.
  * @param   pVM             Pointer to the VM handle for performing the done function
  *                          on the EMT thread.
@@ -1745 +1748 @@
  *
  * @returns VBox status code.
- * @param   pDev    The VUSB device to initialize.
- * @param   pUsbIns Pointer to the PDM USB Device instance.
+ * @param   pDev                  The VUSB device to initialize.
+ * @param   pUsbIns               Pointer to the PDM USB Device instance.
+ * @param   pszCaptureFilename    Optional fileame to capture the traffic to.
  */
 int vusbDevInit(PVUSBDEV pDev, PPDMUSBINS pUsbIns, const char *pszCaptureFilename)

trunk/src/VBox/Devices/USB/VUSBSniffer.cpp

@@ -77 +77 @@
 *********************************************************************************************************************************/
 
-/** @interface_method_impl{VUSBSNIFFERSTRM,pfnWrite}. */
+/** @interface_method_impl{VUSBSNIFFERSTRM,pfnWrite} */
 static DECLCALLBACK(int) vusbSnifferStrmWrite(PVUSBSNIFFERSTRM pStrm, const void *pvBuf, size_t cbBuf)
 {
@@ -106 +106 @@
  *
  * @returns Pointer to the format structure or NULL if none was found.
- * @param   pFilename    The file name to take the suffix from.
+ * @param   pszFilename    The file name to take the suffix from.
  */
 static PCVUSBSNIFFERFMT vusbSnifferGetFmtFromFilename(const char *pszFilename)

trunk/src/VBox/Devices/USB/VUSBUrb.cpp

@@ -745 +745 @@
  *
  * @param   pUrb        The URB to submit.
+ * @param   pSetup      The setup packet for the message transfer.
+ * @param   pExtra      Pointer to the additional state requred for a control transfer.
+ * @param   pPipe       The message pipe state.
  */
 static void vusbMsgDoTransfer(PVUSBURB pUrb, PVUSBSETUP pSetup, PVUSBCTRLEXTRA pExtra, PVUSBPIPE pPipe)

trunk/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp

@@ -1426 +1426 @@
 
 
-/**
- * Reset a device.
- *
- * @returns VBox status code.
- * @param   pDev    The device to reset.
- */
+/** @interface_method_impl{USBPROXYBACK,pfnReset}*/
 static DECLCALLBACK(int) usbProxyDarwinReset(PUSBPROXYDEV pProxyDev, bool fResetOnLinux)
 {

trunk/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp

@@ -408 +408 @@
  * @returns The Cfg#.
  * @returns -1 if no active config.
+ * @param   pProxyDev       The proxy device instance.
  * @param   pszDevNode      The path to the device. We infere the location of
  *                          the devices file, which bus and device number we're
  *                          looking for.
- * @param   iFirstCfg       The first configuration. (optional)
+ * @param   piFirstCfg      The first configuration. (optional)
  * @internal
  */
@@ -543 +544 @@
  * @returns The Cfg#.
  * @returns -1 if no active config.
+ * @param   pProxyDev       The proxy device instance.
  * @param   pszPath         The sysfs path for the device.
  * @param   piFirstCfg      The first configuration. (optional)
@@ -570 +572 @@
  * @returns The Cfg#.
  * @returns -1 if no active config.
+ * @param   pProxyDev       The proxy device instance.
  * @param   pszPath         The sysfs path for the device, or the usbfs device
  *                          node path.
- * @param   iFirstCfg       The first configuration. (optional)
+ * @param   piFirstCfg      The first configuration. (optional)
  * @internal
  */
@@ -1012 +1015 @@
 
 
-/**
- * Reset a device.
- *
- * @returns VBox status code.
- * @param   pDev    The device to reset.
- */
+/** @interface_method_impl{USBPROXYBACK,pfnReset} */
 static DECLCALLBACK(int) usbProxyLinuxReset(PUSBPROXYDEV pProxyDev, bool fResetOnLinux)
 {

trunk/src/VBox/Devices/USB/os2/USBProxyDevice-os2.cpp

@@ -596 +596 @@
 
 
-/**
- * Reset a device.
- *
- * @returns VBox status code.
- * @param   pDev    The device to reset.
- */
+/** @interface_method_impl{USBPROXYBACK,pfnReset} */
 static int usbProxyOs2Reset(PUSBPROXYDEV pProxyDev, bool fResetOnLinux)
 {
@@ -703 +698 @@
  * @interface_method_impl{USBPROXYBACK,pfnUrbQueue}
  */
-static int usbProxyOs2UrbQueue(PVUSBURB pUrb)
-{
-    PUSBPROXYDEV    pProxyDev = (PUSBPROXYDEV)pUrb->pDev;
+static int usbProxyOs2UrbQueue(PUSBPROXYDEV pProxyDev, PVUSBURB pUrb)
+{
     PUSBPROXYDEVOS2 pDevOs2 = (PUSBPROXYDEVOS2)pProxyDev->Backend.pv;
     LogFlow(("usbProxyOs2UrbQueue: pProxyDev=%s pUrb=%p EndPt=%d cbData=%d\n",