Changeset 85879 in vbox

Timestamp:

Aug 24, 2020 5:44:48 PM (5 years ago)

Author:

vboxsync

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

140052

Message:

Main: bugref:9224: fixed doxygen issues

Location:

trunk

Files:

• include/iprt/dvm.h (modified) (3 diffs)
• src/VBox/Runtime/include/internal/dvm.h (modified) (2 diffs)

trunk/include/iprt/dvm.h

@@ -482 +482 @@
  * Query a generic volume property.
  *
- * This is an extensible interface for retriving mostly format specific
- * information, or information that's not commonly used.  (It's modelled after
+ * This is an extensible interface for retrieving mostly format specific
+ * information, or information that's not commonly used.  (It's modeled after
  * RTLdrQueryPropEx.)
  *
@@ -493 +493 @@
  * @retval  VERR_INVALID_FUNCTION if the @a enmProperty value is wrong.
  * @retval  VERR_INVALID_PARAMETER if the fixed buffer size is wrong. Correct
- *          size in @a *pcbRet.
+ *          size in @a *pcbBuf.
  * @retval  VERR_BUFFER_OVERFLOW if the property doesn't have a fixed size
- *          buffer and the buffer isn't big enough. Correct size in @a *pcbRet.
+ *          buffer and the buffer isn't big enough. Correct size in @a *pcbBuf.
  * @retval  VERR_INVALID_HANDLE if the handle is invalid.
  * @param   hVol        Handle to the volume.
@@ -502 +502 @@
  *                      it's only used for returning data.
  * @param   cbBuf       The size of the buffer.
- * @param   pcbRet      Where to return the amount of data returned.  On
+ * @param   pcbBuf      Where to return the amount of data returned.  On
  *                      buffer size errors, this is set to the correct size.
  *                      Optional.

trunk/src/VBox/Runtime/include/internal/dvm.h

@@ -292 +292 @@
      * @retval  VERR_INVALID_FUNCTION if the @a enmProperty value is wrong.
      * @retval  VERR_INVALID_PARAMETER if the fixed buffer size is wrong. Correct
-     *          size in @a *pcbRet.
+     *          size in @a *pcbBuf.
      * @retval  VERR_BUFFER_OVERFLOW if the property doesn't have a fixed size
-     *          buffer and the buffer isn't big enough. Correct size in @a *pcbRet.
+     *          buffer and the buffer isn't big enough. Correct size in @a *pcbBuf.
      * @retval  VERR_INVALID_HANDLE if the handle is invalid.
      *
@@ -307 +307 @@
      *                      is okay to return a smaller amount of data.  The common
      *                      code will make upcast the data.
-     * @param   pcbRet      Where to return the amount of data returned.  This must
+     * @param   pcbBuf      Where to return the amount of data returned.  This must
      *                      be set even for fixed type/sized data.
      * @sa RTDvmVolumeQueryProp, RTDvmVolumeGetPropU64