Changeset 64366 in vbox for trunk/src/VBox

Timestamp:

Oct 22, 2016 4:36:39 PM (8 years ago)

Author:

vboxsync

Message:

ValidationKit: Doxygen

Location:

trunk/src/VBox/ValidationKit/utils

Files:

• TestExecServ/TestExecService.cpp (modified) (8 diffs)
• TestExecServ/TestExecServiceInternal.h (modified) (2 diffs)
• TestExecServ/TestExecServiceTcp.cpp (modified) (1 diff)
• cpu/cidet-app.cpp (modified) (8 diffs)
• misc/loadgeneratorR0.cpp (modified) (1 diff)
• network/NetPerf.cpp (modified) (2 diffs)

trunk/src/VBox/ValidationKit/utils/TestExecServ/TestExecService.cpp

@@ -387 +387 @@
  * @param   pszOpcode           The status opcode.  Exactly 8 chars long, padd
  *                              with space.
- * @param   pszDetailsFmt       Longer description of the problem (format
+ * @param   pszDetailFmt        Longer description of the problem (format
  *                              string).
  * @param   va                  Format arguments.
@@ -413 +413 @@
  * @param   pszOpcode           The status opcode.  Exactly 8 chars long, padd
  *                              with space.
- * @param   pszDetails          Longer description of the problem (format
+ * @param   pszDetailFmt        Longer description of the problem (format
  *                              string).
  * @param   ...                 Format arguments.
@@ -1575 +1575 @@
  * @param   fPollEvt            The event mask returned by RTPollNoResume.
  * @param   phPipeR             The pipe handle.
- * @param   pu32Crc             The current CRC-32 of the stream. (In/Out)
+ * @param   puCrc32             The current CRC-32 of the stream. (In/Out)
  * @param   enmHndId            The handle ID.
  * @param   pszOpcode           The opcode for the data upload.
@@ -1735 +1735 @@
  * @param   fPollEvt            The event mask returned by RTPollNoResume.
  * @param   idPollHnd           The handle ID.
- * @param   hStdInW             The standard input pipe.
+ * @param   phStdInW            The standard input pipe.
  * @param   pStdInBuf           The standard input buffer.
  */
@@ -2240 +2240 @@
  * @param   pTxsExec            The TXSEXEC instance.
  * @param   pszHowTo            How to set up this standard handle.
+ * @param   pszStdWhat          For what to setup redirection (stdin/stdout/stderr).
  * @param   fd                  Which standard handle it is (0 == stdin, 1 ==
  *                              stdout, 2 == stderr).
@@ -2891 +2892 @@
  * @param   argv                The argument vector.
  * @param   pfExit              For indicating exit when the exit code is zero.
+ * @param   pszUpgrading        The upgraded image path.
  */
 static RTEXITCODE txsAutoUpdateStage2(int argc, char **argv, bool *pfExit, const char *pszUpgrading)
@@ -3193 +3195 @@
  * @param   pszArgv0            The program name (argv[0]).
  */
-static void txsUsage(PRTSTREAM pStrm, const char *argv0)
+static void txsUsage(PRTSTREAM pStrm, const char *pszArgv0)
 {
     RTStrmPrintf(pStrm,
@@ -3206 +3208 @@
                  "      Default: %s \n"
                  ,
-                 argv0,
+                 pszArgv0,
                  g_szDefCdRomPath,
                  g_szDefScratchPath);

trunk/src/VBox/ValidationKit/utils/TestExecServ/TestExecServiceInternal.h

@@ -77 +77 @@
      * 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.
      *
@@ -94 +93 @@
      * @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.

trunk/src/VBox/ValidationKit/utils/TestExecServ/TestExecServiceTcp.cpp

@@ -347 +347 @@
 
 /**
- * @interface_method_impl{TXSTRANSPORT,txsTcpNotifyReboot}
+ * @interface_method_impl{TXSTRANSPORT,pfnNotifyReboot}
  */
 static DECLCALLBACK(void) txsTcpNotifyReboot(void)

trunk/src/VBox/ValidationKit/utils/cpu/cidet-app.cpp

@@ -59 +59 @@
  * restore the lower 32-bits of the base when saving and restoring the register).
  */
-#if defined(RT_OS_DARWIN) && defined(RT_ARCH_AMD64)
+#if (defined(RT_OS_DARWIN) && defined(RT_ARCH_AMD64)) || defined(DOXYGEN_RUNNING)
 # define CIDET_LEAVE_GS_ALONE
 #endif
@@ -709 +709 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnReInitDataBuf}
+ * @interface_method_impl{CIDETCORE,pfnReInitDataBuf}
  */
 static DECLCALLBACK(bool) CidetAppCbReInitDataBuf(PCIDETCORE pThis, PCIDETBUF pBuf)
@@ -763 +763 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnSetupDataBuf}
+ * @interface_method_impl{CIDETCORE,pfnSetupDataBuf}
  */
 static DECLCALLBACK(bool) CidetAppCbSetupDataBuf(PCIDETCORE pThis, PCIDETBUF pBuf, void const *pvSrc)
@@ -787 +787 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnIsBufEqual}
+ * @interface_method_impl{CIDETCORE,pfnIsBufEqual}
  */
 static DECLCALLBACK(bool) CidetAppCbIsBufEqual(PCIDETCORE pThis, struct CIDETBUF *pBuf, void const *pvExpected)
@@ -831 +831 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnReInitCodeBuf}
+ * @interface_method_impl{CIDETCORE,pfnReInitCodeBuf}
  */
 static DECLCALLBACK(bool) CidetAppCbReInitCodeBuf(PCIDETCORE pThis, PCIDETBUF pBuf)
@@ -885 +885 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnSetupCodeBuf}
+ * @interface_method_impl{CIDETCORE,pfnSetupCodeBuf}
  */
 static DECLCALLBACK(bool) CidetAppCbSetupCodeBuf(PCIDETCORE pThis, PCIDETBUF pBuf, void const *pvInstr)
@@ -1055 +1055 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnExecute}
+ * @interface_method_impl{CIDETCORE,pfnExecute}
  */
 static DECLCALLBACK(bool) CidetAppCbExecute(PCIDETCORE pThis)
@@ -1105 +1105 @@
 
 /**
- * @interface_method_impl{CIDETCORE::pfnSetupBuf}
- */
-static DECLCALLBACK(void) CidetAppCbFailureV(PCIDETCORE pThis, const char *pszMsg, va_list va)
+ * @interface_method_impl{CIDETCORE,pfnFailure}
+ */
+static DECLCALLBACK(void) CidetAppCbFailureV(PCIDETCORE pThis, const char *pszFormat, va_list va)
 {
     RT_NOREF_PV(pThis);
-    RTTestIFailedV(pszMsg, va);
+    RTTestIFailedV(pszFormat, va);
 }
 

trunk/src/VBox/ValidationKit/utils/misc/loadgeneratorR0.cpp

@@ -71 +71 @@
  * Service request handler entry point.
  *
- * @copydoc SUPR0SERVICEREQHANDLER
+ * @copydoc FNSUPR0SERVICEREQHANDLER
  */
 extern "C" DECLEXPORT(int) LoadGenR0ServiceReqHandler(PSUPDRVSESSION pSession, uint32_t uOperation,

trunk/src/VBox/ValidationKit/utils/network/NetPerf.cpp

@@ -719 +719 @@
  *
  * @param   pStats              The statistics.
+ * @param   cbPacket            The packet size in bytes.
  */
 static void netperfPrintLatencyStats(NETPERFSTATS const *pStats, uint32_t cbPacket)
@@ -1704 +1705 @@
  * @returns Exit code.
  * @param   enmProto            The protocol.
- * @param   pParams             The parameter block.
+ * @param   pszServer           The server name.
+ * @param   pvUser              The parameter block as opaque user data.
  */
 static RTEXITCODE netperfClient(NETPERFPROTO enmProto, const char *pszServer, void *pvUser)