Changeset 64365 in vbox for trunk/src/VBox

Timestamp:

Oct 22, 2016 4:33:45 PM (8 years ago)

Author:

vboxsync

Message:

ValidationKit/UsbTestService: Doxygen

Location:

trunk/src/VBox/ValidationKit/utils/usb

Files:

• UsbTestService.cpp (modified) (6 diffs)
• UsbTestServiceGadgetClassTest.cpp (modified) (5 diffs)
• UsbTestServiceInternal.h (modified) (9 diffs)
• UsbTestServicePlatform-linux.cpp (modified) (1 diff)

trunk/src/VBox/ValidationKit/utils/usb/UsbTestService.cpp

@@ -397 +397 @@
  * @param   pszOpcode           The status opcode.  Exactly 8 chars long, padd
  *                              with space.
- * @param   pszDetailsFmt       Longer description of the problem (format
- *                              string).
+ * @param   rcReq               The status code of the request.
+ * @param   pszDetailFmt        Longer description of the problem (format string).
  * @param   va                  Format arguments.
  */
@@ -425 +425 @@
  * @param   pClient             The UTS client structure.
  * @param   pPktHdr             The original packet (for future use).
- * @param   rcReq               Status code.
  * @param   pszOpcode           The status opcode.  Exactly 8 chars long, padd
  *                              with space.
- * @param   pszDetails          Longer description of the problem (format
- *                              string).
+ * @param   rcReq               Status code.
+ * @param   pszDetailFmt        Longer description of the problem (format string).
  * @param   ...                 Format arguments.
  */
@@ -551 +550 @@
  * @returns IPRT status code.
  * @retval  VERR_OUT_OF_RANGE if the parsed value exceeds the given maximum.
+ * @param   pszVal              The value string.
  * @param   uMax                The maximum value.
  * @param   pu64                Where to store the parsed number on success.
@@ -571 +571 @@
  * @returns IPRT status code.
  * @retval  VERR_OUT_OF_RANGE if the parsed value exceeds the given range.
+ * @param   pszVal              The value string.
  * @param   iMin                The minimum value.
  * @param   iMax                The maximum value.
@@ -1392 +1393 @@
  * @param   pszArgv0            The program name (argv[0]).
  */
-static void utsUsage(PRTSTREAM pStrm, const char *argv0)
+static void utsUsage(PRTSTREAM pStrm, const char *pszArgv0)
 {
     RTStrmPrintf(pStrm,
@@ -1407 +1408 @@
                  "      Default: %s \n"
                  ,
-                 argv0,
+                 pszArgv0,
                  g_szDefCdRomPath,
                  g_szDefScratchPath);

trunk/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetClassTest.cpp

@@ -276 +276 @@
 
 /**
- * @interface_method_impl{UTSGADGETCLASS,pfnInit}
+ * @interface_method_impl{UTSGADGETCLASSIF,pfnInit}
  */
 static DECLCALLBACK(int) utsGadgetClassTestInit(PUTSGADGETCLASSINT pClass, PCUTSGADGETCFGITEM paCfg)
@@ -397 +397 @@
 
 /**
- * @interface_method_impl{UTSGADGETCLASS,pfnTerm}
+ * @interface_method_impl{UTSGADGETCLASSIF,pfnTerm}
  */
 static DECLCALLBACK(void) utsGadgetClassTestTerm(PUTSGADGETCLASSINT pClass)
@@ -409 +409 @@
 
 /**
- * @interface_method_impl{UTSGADGETCLASS,pfnGetBusId}
+ * @interface_method_impl{UTSGADGETCLASSIF,pfnGetBusId}
  */
 static DECLCALLBACK(uint32_t) utsGadgetClassTestGetBusId(PUTSGADGETCLASSINT pClass)
@@ -418 +418 @@
 
 /**
- * @interface_method_impl{UTSGADGETCLASS,pfnConnect}
+ * @interface_method_impl{UTSGADGETCLASSIF,pfnConnect}
  */
 static DECLCALLBACK(int) utsGadgetClassTestConnect(PUTSGADGETCLASSINT pClass)
@@ -431 +431 @@
 
 /**
- * @interface_method_impl{UTSGADGETCLASS,pfnDisconnect}
+ * @interface_method_impl{UTSGADGETCLASSIF,pfnDisconnect}
  */
 static DECLCALLBACK(int) utsGadgetClassTestDisconnect(PUTSGADGETCLASSINT pClass)

trunk/src/VBox/ValidationKit/utils/usb/UsbTestServiceInternal.h

@@ -56 +56 @@
      * Print the usage information for this transport layer.
      *
-     * @param   pThis               Pointer to the transport layer descriptor.
      * @param   pStream             The stream to print the usage info to.
      *
@@ -73 +72 @@
      * @retval  VERR_INVALID_PARAMETER if we should exit with a non-zero status.
      *
-     * @param   pThis               Pointer to the transport layer descriptor.
      * @param   ch                  The short option value.
      * @param   pVal                Pointer to the value union.
@@ -116 +114 @@
      * @returns IPRT status code.
      * @param   hPollSet            The poll set to add them to.
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      * @param   idStart             The handle ID to start at.
      */
@@ -126 +124 @@
      * @returns IPRT status code.
      * @param   hPollSet            The poll set to remove from.
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      * @param   idStart             The handle ID to remove.
      */
@@ -142 +140 @@
      *          receive call.
      *
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      * @param   ppPktHdr            Where to return the pointer to the packet we've
      *                              read.  This is allocated from the heap using
@@ -158 +156 @@
      * @retval  VERR_INTERRUPTED if interrupted before anything was sent.
      *
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      * @param   pPktHdr             The packet to send.  The size is given by
      *                              aligning the size in the header by
@@ -168 +166 @@
      * Sends a babble packet and disconnects the client (if applicable).
      *
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      * @param   pPktHdr             The packet to send.  The size is given by
      *                              aligning the size in the header by
@@ -179 +177 @@
      * Notification about a client HOWDY.
      *
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      */
     DECLR3CALLBACKMEMBER(void, pfnNotifyHowdy, (PUTSTRANSPORTCLIENT pClient));
@@ -189 +187 @@
      * client at this point.
      *
-     * @paramm  pClient             The transport client structure.
+     * @param   pClient             The transport client structure.
      */
     DECLR3CALLBACKMEMBER(void, pfnNotifyBye, (PUTSTRANSPORTCLIENT pClient));

trunk/src/VBox/ValidationKit/utils/usb/UsbTestServicePlatform-linux.cpp

@@ -282 +282 @@
     if (RT_SUCCESS(rc))
     {
-        const char *apszArg[] = { "num=20" }; /** @todo Make configurable from config. */
+        const char *apszArg[] = { "num=20" }; /** @todo: Make configurable from config. */
         rc = utsPlatformModuleLoad("dummy_hcd", &apszArg[0], RT_ELEMENTS(apszArg));
         if (RT_SUCCESS(rc))