Changeset 57944 in vbox for trunk/include/iprt/vfs.h

Timestamp:

Sep 29, 2015 3:07:09 PM (9 years ago)

Author:

vboxsync

Message:

iprt: More doxygen corrections.

File:

• trunk/include/iprt/vfs.h (modified) (8 diffs)

trunk/include/iprt/vfs.h

@@ -227 +227 @@
  *
  * @returns Referenced handle on success, NIL if the input handle was invalid.
- * @param   hVfsFSs         The VFS filesystem stream handle.
+ * @param   hVfsFss         The VFS filesystem stream handle.
  */
 RTDECL(RTVFSOBJ)        RTVfsObjFromFsStream(RTVFSFSSTREAM hVfsFss);
@@ -298 +298 @@
  * @retval  VERR_EOF when there are no more objects.
  *
- * @param   pvThis      The implementation specific directory data.
+ * @param   hVfsFss     The file system stream handle.
  * @param   ppszName    Where to return the object name.  Must be freed by
  *                      calling RTStrFree.
  * @param   penmType    Where to return the object type.
- * @param   hVfsObj     Where to return the object handle (referenced).
- *                      This must be cast to the desired type before use.
+ * @param   phVfsObj    Where to return the object handle (referenced). This
+ *                      must be cast to the desired type before use.
  */
 RTDECL(int)         RTVfsFsStrmNext(RTVFSFSSTREAM hVfsFss, char **ppszName, RTVFSOBJTYPE *penmType, PRTVFSOBJ phVfsObj);
@@ -326 +326 @@
  *
  * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
- * @param   hVfsIos         The VFS directory handle.
+ * @param   hVfsDir         The VFS directory handle.
  */
 RTDECL(uint32_t)    RTVfsDirRelease(RTVFSDIR hVfsDir);
@@ -567 +567 @@
  * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
  *                          not, the @a pcbWritten parameter must not be NULL.
- * @param   pcbRead         Where to always store the number of bytes actually
+ * @param   pcbWritten      Where to always store the number of bytes actually
  *                          written.  This can be NULL if @a fBlocking is true.
  * @sa      RTVfsFileWrite, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
@@ -771 +771 @@
  *          implementation.
  *
- * @param   hVfsObj         The VFS object handle.
+ * @param   hVfsFile        The VFS file handle.
  * @param   pObjInfo        Where to return the info.
  * @param   enmAddAttr      Which additional attributes should be retrieved.
@@ -801 +801 @@
  * @param   pvBuf           Where to store the read bytes.
  * @param   cbToRead        The number of bytes to read.
- * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
- *                          not, the @a pcbRead parameter must not be NULL.
  * @param   pcbRead         Where to always store the number of bytes actually
- *                          read.  This can be NULL if @a fBlocking is true.
+ *                          read.  Optional.
  * @sa      RTVfsIoStrmRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
  *          RTSocketRead
@@ -820 +818 @@
  * @param   pvBuf           The bytes to write.
  * @param   cbToWrite       The number of bytes to write.
- * @param   fBlocking       Whether the call is blocking (@c true) or not.  If
- *                          not, the @a pcbWritten parameter must not be NULL.
- * @param   pcbRead         Where to always store the number of bytes actually
- *                          written.  This can be NULL if @a fBlocking is true.
+ * @param   pcbWritten      Where to always store the number of bytes actually
+ *                          written.  This can be NULL.
  * @sa      RTVfsIoStrmRead, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
  *          RTSocketWrite
@@ -910 +906 @@
  *
  * The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
- * until @hVfsIosSrc indicates end of stream.
+ * until @a hVfsIosSrc indicates end of stream.
  *
  * @returns IPRT status code