Changeset 89015 in vbox

Timestamp:

May 12, 2021 2:40:56 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

144354

Message:

Audio/ValKit: Warnings, docs. bugref:10008

File:

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

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

@@ -494 +494 @@
 }
 
+/**
+ * Creates an audio test stream.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment to use for creating the stream.
+ * @param   pStream             Audio stream to create.
+ * @param   pCfg                Stream configuration to use for creation.
+ */
 static int audioTestStreamCreate(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PPDMAUDIOSTREAMCFG pCfg)
 {
@@ -515 +523 @@
 }
 
+/**
+ * Destroys an audio test stream.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment the stream to destroy contains.
+ * @param   pStream             Audio stream to destroy.
+ */
 static int audioTestStreamDestroy(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream)
 {
@@ -520 +535 @@
         return VINF_SUCCESS;
 
-  if (!pStream->fCreated)
+    if (!pStream->fCreated)
         return VINF_SUCCESS;
 
@@ -532 +547 @@
 }
 
+/**
+ * Creates an audio default output test stream.
+ * Convenience function.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment to use for creating the stream.
+ * @param   pStream             Audio stream to create.
+ * @param   pProps              PCM properties to use for creation.
+ */
 static int audioTestCreateStreamDefaultOut(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PPDMAUDIOPCMPROPS pProps)
 {
@@ -545 +569 @@
 }
 
+/**
+ * Plays a test tone on a specific audio test stream.
+ *
+ * @returns VBox status code.
+ * @param   pTstEnv             Test environment to use for running the test.
+ * @param   pStream             Stream to use for playing the tone.
+ * @param   pParms              Tone parameters to use.
+ *
+ * @note    Blocking function.
+ */
 static int audioTestPlayTone(PAUDIOTESTENV pTstEnv, PAUDIOTESTSTREAM pStream, PAUDIOTESTTONEPARMS pParms)
 {
@@ -629 +663 @@
     RT_NOREF(pvCtx);
 
-    int rc;
+    int rc = VINF_SUCCESS;
 
     PAUDIOTESTSTREAM pStream = &pTstEnv->aStreams[0];