Changeset 69756 in vbox for trunk/include/iprt

Timestamp:

Nov 19, 2017 2:49:04 PM (7 years ago)

Author:

vboxsync

Message:

iprt/dir.h: doc updates

File:

• trunk/include/iprt/dir.h (modified) (7 diffs)

trunk/include/iprt/dir.h

@@ -343 +343 @@
  *
  * @returns iprt status code.
- * @param   phDir       Where to store the open directory pointer.
+ * @param   phDir       Where to store the open directory handle.
  * @param   pszPath     Path to the directory to open.
  */
@@ -363 +363 @@
  *
  * @returns iprt status code.
- * @param   phDir       Where to store the open directory pointer.
+ * @param   phDir       Where to store the open directory handle.
  * @param   pszPath     Path to the directory to search, this must include wildcards.
  * @param   enmFilter   The kind of filter to apply. Setting this to RTDIRFILTER_NONE makes
@@ -375 +375 @@
  *
  * @returns iprt status code.
- * @param   pDir        Pointer to open directory returned by RTDirOpen() or RTDirOpenFiltered().
+ * @param   hDir        Handle to open directory returned by RTDirOpen() or
+ *                      RTDirOpenFiltered().
  */
 RTDECL(int) RTDirClose(RTDIR hDir);
@@ -397 +398 @@
  * @returns suitable iprt status code on other errors.
  *
- * @param   pDir        Pointer to the open directory.
+ * @param   hDir        Handle to the open directory.
  * @param   pDirEntry   Where to store the information about the next
  *                      directory entry on success.
@@ -424 +425 @@
  * @returns suitable iprt status code on other errors.
  *
- * @param   pDir        Pointer to the open directory.
+ * @param   hDir        Handle to the open directory.
  * @param   pDirEntry   Where to store the information about the next
  *                      directory entry on success.
@@ -517 +518 @@
  * @returns iprt status code.
  *
- * @param   pDir        Pointer to the open directory.
+ * @param   hDir                    Handle to the open directory.
  * @param   pObjInfo                Object information structure to be filled on successful return.
  * @param   enmAdditionalAttribs    Which set of additional attributes to request.
@@ -531 +532 @@
  * @returns VERR_NOT_SUPPORTED is returned if the operation isn't supported by the OS.
  *
- * @param   pDir        Pointer to the open directory.
+ * @param   hDir                Handle to the open directory.
  * @param   pAccessTime         Pointer to the new access time. NULL if not to be changed.
  * @param   pModificationTime   Pointer to the new modifcation time. NULL if not to be changed.