Changeset 58106 in vbox for trunk/include/VBox/vd-ifs-internal.h

Timestamp:

Oct 7, 2015 5:07:25 PM (10 years ago)

Author:

vboxsync

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

103197

Message:

include,misc: Corrected a bunch of doxygen errors.

File:

• trunk/include/VBox/vd-ifs-internal.h (modified) (4 diffs)

trunk/include/VBox/vd-ifs-internal.h

@@ -129 +129 @@
      * @param   pszLocation     Name of the location to open.
      * @param   fOpen           Flags for opening the backend.
-     *                          See RTFILE_O_* #defines, inventing another set
+     *                          See RTFILE_O_* \#defines, inventing another set
      *                          of open flags is not worth the mapping effort.
      * @param   ppStorage       Where to store the storage handle.
@@ -256 +256 @@
      * @param   pvCompleteUser Opaque user data passed in the completion callback.
      *
-     * @notes If pIoCtx is NULL the metadata read is handled synchronously
-     *        i.e. the call returns only if the data is available in the given
-     *        buffer. ppMetaXfer, pfnCompleted and pvCompleteUser are ignored in that case.
-     *        Use the synchronous version only when opening/closing the image
-     *        or when doing certain operations like resizing, compacting or repairing
-     *        the disk.
+     * @note    If pIoCtx is NULL the metadata read is handled synchronously
+     *          i.e. the call returns only if the data is available in the given
+     *          buffer. ppMetaXfer, pfnCompleted and pvCompleteUser are ignored in that case.
+     *          Use the synchronous version only when opening/closing the image
+     *          or when doing certain operations like resizing, compacting or repairing
+     *          the disk.
      */
     DECLR3CALLBACKMEMBER(int, pfnReadMeta, (void *pvUser, PVDIOSTORAGE pStorage,
@@ -283 +283 @@
      * @param   pvCompleteUser Opaque user data passed in the completion callback.
      *
-     * @notes See pfnReadMeta().
+     * @sa      VDINTERFACEIOINT::pfnReadMeta
      */
     DECLR3CALLBACKMEMBER(int, pfnWriteMeta, (void *pvUser, PVDIOSTORAGE pStorage,
@@ -311 +311 @@
      * @param   pvCompleteUser Opaque user data passed in the completion callback.
      *
-     * @notes See pfnReadMeta().
+     * @sa      VDINTERFACEIOINT::pfnReadMeta
      */
     DECLR3CALLBACKMEMBER(int, pfnFlush, (void *pvUser, PVDIOSTORAGE pStorage,