Changeset 89461 in vbox for trunk/src/VBox

Timestamp:

Jun 2, 2021 10:10:57 AM (4 years ago)

Author:

vboxsync

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

144815

Message:

Audio/ValKit: Docs. bugref:10008

File:

• trunk/src/VBox/Devices/Audio/AudioTest.h (modified) (2 diffs)

trunk/src/VBox/Devices/Audio/AudioTest.h

@@ -239 +239 @@
 struct AUDIOTESTSET;
 
+/**
+ * Structure specifying a single audio test entry of a test set.
+ *
+ * A test set can contain zero or more test entry (tests).
+ */
 typedef struct AUDIOTESTENTRY
 {
     /** List node. */
     RTLISTNODE           Node;
+    /** Pointer to test set parent. */
     AUDIOTESTSET        *pParent;
+    /** Friendly description of the test. */
     char                 szDesc[64];
+    /** Audio test parameters this test needs to perform the actual test. */
     AUDIOTESTPARMS       Parms;
     /** Number of test objects bound to this test. */
@@ -250 +258 @@
     /** Absolute offset (in bytes) where to write the "obj_count" value later. */
     uint64_t             offObjCount;
+    /** Overall test result. */
     int                  rc;
 } AUDIOTESTENTRY;