Changeset 47834 in vbox for trunk/include/iprt

Timestamp:

Aug 19, 2013 9:03:37 AM (12 years ago)

Author:

vboxsync

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

88104

Message:

IPRT/file.h: Documentation.

File:

• trunk/include/iprt/file.h (modified) (1 diff)

trunk/include/iprt/file.h

@@ -619 +619 @@
  *
  * Access modes:
- *      "r"  - Read
- *      "r+" - Read / Write
- *      "w"  - Write
- *      "w+" - Write / Read
+ *      "r"  - Opens a file for reading.
+ *      "r+" - Opens a file for reading and writing.
+ *      "w"  - Opens a file for writing.
+ *      "w+" - Opens a file for writing and reading.
  *
  * Disposition modes:
- *      "ca" - Create a new file, always, overwrite existing
- *      "ce" - Create a new file if not exist, fail if exist
- *      "oc" - Open existing, create if not exist
- *      "oe" - Open existing, fail if not exist
- *      "ot" - Open and truncate existing, fail of not exist
+ *      "ca" - Creates a new file, always. Overwrites an existing file.
+ *      "ce" - Creates a new file if it does not exist. Fail if exist.
+ *      "oc" - Opens and existing file or create it if it does not exist.
+ *      "oe" - Opens an existing file or fail if it does not exist.
+ *      "ot" - Opens and truncate an existing file or fail if it does not exist.
  *
  * Sharing modes: