Changeset 16516 in vbox for trunk/src/VBox/Runtime

Timestamp:

Feb 4, 2009 3:56:35 PM (16 years ago)

Author:

vboxsync

Message:

IPRT: documentation.

File:

• trunk/src/VBox/Runtime/r3/path.cpp (modified) (1 diff)

trunk/src/VBox/Runtime/r3/path.cpp

@@ -48 +48 @@
 
 /**
- * Strips the filename from a path.
- *
- * @param   pszPath     Path which filename should be extracted from.
- *                      If only filename in the string a '.' will be returned.
- *
+ * Strips the filename from a path. Truncates the given string in-place by overwriting the
+ * last path separator character with a null byte in a platform-neutral way.
+ *
+ * @param   pszPath     Path from which filename should be extracted, will be truncated.
+ *                      If the string contains no path separator, it will be changed to a "." string.
  */
 RTDECL(void) RTPathStripFilename(char *pszPath)