Changeset 67864 in vbox for trunk/src/VBox/Runtime/common/fs/isomakercmd.cpp

Timestamp:

Jul 7, 2017 5:49:07 PM (8 years ago)

Author:

vboxsync

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

116820

Message:

isomaker: doxygen updates

File:

• trunk/src/VBox/Runtime/common/fs/isomakercmd.cpp (modified) (3 diffs)

trunk/src/VBox/Runtime/common/fs/isomakercmd.cpp

@@ -737 +737 @@
 }
 
-static int rtFsIsoMakerCmdVerifyImageInRandomOrder(PRTFSISOMAKERCMDOPTS pOpts, RTVFSFILE hVfsSrcFile, RTVFSFILE hVfsDstFile, uint64_t cbImage)
+
+/**
+ * Verifies the image content by reading blocks in random order.
+ *
+ * This is for exercise the virtual ISO code better and test that we get the
+ * same data when reading something twice.
+ *
+ * @returns IPRT status code.
+ * @param   pOpts               The ISO maker command instance.
+ * @param   hVfsSrcFile         The source file (virtual ISO).
+ * @param   hVfsDstFile         The destination file (image file on disk).
+ * @param   cbImage             The size of the ISO.
+ */
+static int rtFsIsoMakerCmdVerifyImageInRandomOrder(PRTFSISOMAKERCMDOPTS pOpts, RTVFSFILE hVfsSrcFile,
+                                                   RTVFSFILE hVfsDstFile, uint64_t cbImage)
 {
     /*
@@ -882 +896 @@
  * @param   pOpts               The ISO maker command instance.
  * @param   hVfsSrcFile         The source file from the ISO maker.
+ * @param   hVfsDstFile         The destination file (image file on disk).
+ * @param   cbImage             The size of the ISO.
+ * @param   ppvBuf              Pointer to the buffer pointer.  The buffer will
+ *                              be reallocated, but we want the luxary of the
+ *                              caller freeing it.
  */
 static int rtFsIsoMakerCmdWriteImageRandomBufferSize(PRTFSISOMAKERCMDOPTS pOpts, RTVFSFILE hVfsSrcFile, RTVFSFILE hVfsDstFile,
@@ -931 +950 @@
  * @param   pOpts               The ISO maker command instance.
  * @param   hVfsSrcFile         The source file from the ISO maker.
+ * @param   hVfsDstFile         The destination file (image file on disk).
+ * @param   cbImage             The size of the ISO.
+ * @param   pvBuf               Pointer to read buffer.
+ * @param   cbBuf               The buffer size.
  */
 static int rtFsIsoMakerCmdWriteImageSimple(PRTFSISOMAKERCMDOPTS pOpts, RTVFSFILE hVfsSrcFile, RTVFSFILE hVfsDstFile,