Changeset 88962 in vbox for trunk/src/VBox/ValidationKit/utils/audio

Timestamp:

May 10, 2021 11:50:21 AM (4 years ago)

Author:

vboxsync

Message:

Audio/ValKit: Docs. bugref:10008

File:

• trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp (modified) (13 diffs)

trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp

@@ -235 +235 @@
 *********************************************************************************************************************************/
 
+/**
+ * Initializes an audio test environment.
+ *
+ * @param   pTstEnv             Audio test environment to initialize.
+ * @param   pDrvAudio           Audio driver to use.
+ */
 static void audioTestEnvInit(PAUDIOTESTENV pTstEnv, PPDMIHOSTAUDIO pDrvAudio)
 {
@@ -245 +251 @@
 }
 
+/**
+ * Destroys an audio test environment.
+ *
+ * @param   pTstEnv             Audio test environment to destroy.
+ */
 static void audioTestEnvDestroy(PAUDIOTESTENV pTstEnv)
 {
@@ -253 +264 @@
 }
 
+/**
+ * Initializes an audio test parameters set.
+ *
+ * @param   pTstParms           Test parameters set to initialize.
+ */
 static void audioTestParmsInit(PAUDIOTESTPARMS pTstParms)
 {
@@ -259 +275 @@
 }
 
+/**
+ * Destroys an audio test parameters set.
+ *
+ * @param   pTstParms           Test parameters set to destroy.
+ */
 static void audioTestParmsDestroy(PAUDIOTESTPARMS pTstParms)
 {
@@ -319 +340 @@
 }
 
+/**
+ * Constructs a PDM audio driver instance.
+ *
+ * @returns VBox status code.
+ * @param   pDrvReg             PDM driver registration record to use for construction.
+ * @param   pDrvIns             Driver instance to use for construction.
+ * @param   ppDrvAudio          Where to return the audio driver interface of type IHOSTAUDIO.
+ */
 static int audioTestDrvConstruct(const PDMDRVREG *pDrvReg, PPDMDRVINS pDrvIns, PPDMIHOSTAUDIO *ppDrvAudio)
 {
@@ -341 +370 @@
 }
 
+/**
+ * Destructs a PDM audio driver instance.
+ *
+ * @returns VBox status code.
+ * @param   pDrvReg             PDM driver registration record to destruct.
+ * @param   pDrvIns             Driver instance to destruct.
+ */
 static int audioTestDrvDestruct(const PDMDRVREG *pDrvReg, PPDMDRVINS pDrvIns)
 {
@@ -358 +394 @@
 }
 
+/**
+ * Enumerates audio devices and optionally searches for a specific device.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test env to use for enumeration.
+ * @param   pszDev              Device name to search for. Can be NULL if the default device shall be used.
+ * @param   ppDev               Where to return the pointer of the device enumeration of \a pTstEnv when a
+ *                              specific device was found.
+ */
 static int audioTestDevicesEnumerateAndCheck(PAUDIOTESTENV pTstEnv, const char *pszDev, PPDMAUDIOHOSTDEV *ppDev)
 {
@@ -408 +453 @@
 }
 
+/**
+ * Opens an audio device.
+ *
+ * @returns VBox status code.
+ * @param   pDev                Audio device to open.
+ */
 static int audioTestDeviceOpen(PPDMAUDIOHOSTDEV pDev)
 {
@@ -421 +472 @@
 }
 
+/**
+ * Closes an audio device.
+ *
+ * @returns VBox status code.
+ * @param   pDev                Audio device to close.
+ */
 static int audioTestDeviceClose(PPDMAUDIOHOSTDEV pDev)
 {
@@ -440 +497 @@
 }
 
+/**
+ * Runs one specific audio test.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment to use for running the test.
+ * @param   pTstDesc            Test to run.
+ * @param   uSeq                Test sequence # in case there are more tests.
+ * @param   pOverrideParms      Test parameters for overriding the actual test parameters. Optional.
+ */
 static int audioTestOne(PAUDIOTESTENV pTstEnv, PAUDIOTESTDESC pTstDesc,
                         unsigned uSeq, PAUDIOTESTPARMS pOverrideParms)
@@ -491 +557 @@
 }
 
+/**
+ * Runs all specified tests in a row.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment to use for running all tests.
+ * @param   pOverrideParms      Test parameters for (some / all) specific test parameters. Optional.
+ */
 static int audioTestWorker(PAUDIOTESTENV pTstEnv, PAUDIOTESTPARMS pOverrideParms)
 {
@@ -509 +582 @@
 }
 
+/**
+ * Main (entry) function for the testing functionality of VKAT.
+ *
+ * @returns RTEXITCODE
+ * @param   argc                Number of argv arguments.
+ * @param   argv                argv arguments.
+ */
 int mainTest(int argc, char **argv)
 {
@@ -699 +779 @@
 }
 
+/**
+ * Main (entry) function for the verification functionality of VKAT.
+ *
+ * @returns RTEXITCODE
+ * @param   argc                Number of argv arguments.
+ * @param   argv                argv arguments.
+ */
 int mainVerify(int argc, char **argv)
 {
     RT_NOREF(argc, argv);
-    return 0;
+
+    return RTMsgErrorExit(RTEXITCODE_SKIPPED, "Sorry, not implemented yet!\n");
 }