Changeset 99758 in vbox for trunk/src/VBox/Runtime/common/path

Timestamp:

May 11, 2023 9:37:59 PM (2 years ago)

Author:

vboxsync

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

157349

Message:

IPRT: Make doxygen 1.9.6 happy. Mostly removing duplicate docs (iprt is documented in the header files). bugref:10442

Location:

trunk/src/VBox/Runtime/common/path

Files:

• RTPathAbsDup.cpp (modified) (1 diff)
• RTPathParentLength.cpp (modified) (1 diff)
• RTPathParseSimple.cpp (modified) (1 diff)
• RTPathRealDup.cpp (modified) (1 diff)
• comparepaths.cpp (modified) (2 diffs)

trunk/src/VBox/Runtime/common/path/RTPathAbsDup.cpp

@@ -43 +43 @@
 
 
-/**
- * Same as RTPathAbs only the result is RTStrDup()'ed.
- *
- * @returns Pointer to real path. Use RTStrFree() to free this string.
- * @returns NULL if RTPathAbs() or RTStrDup() fails.
- * @param   pszPath         The path to resolve.
- */
 RTDECL(char *) RTPathAbsDup(const char *pszPath)
 {

trunk/src/VBox/Runtime/common/path/RTPathParentLength.cpp

@@ -85 +85 @@
 
 
-
-
-/**
- * Determins the length of the path specifying the parent directory, including
- * trailing path separator (if present).
- *
- * @returns Parent directory part of the path, 0 if no parent.
- * @param   pszPath         The path to examine.
- *
- * @note    Currently ignores UNC and may therefore return the server or
- *          double-slash prefix as parent.
- */
 RTDECL(size_t) RTPathParentLength(const char *pszPath)
 {

trunk/src/VBox/Runtime/common/path/RTPathParseSimple.cpp

@@ -46 +46 @@
 
 
-/**
- * Parses a path.
- *
- * It figures the length of the directory component, the offset of
- * the file name and the location of the suffix dot.
- *
- * @returns The path length.
- *
- * @param   pszPath     Path to find filename in.
- * @param   pcchDir     Where to put the length of the directory component. If
- *                      no directory, this will be 0. Optional.
- * @param   poffName    Where to store the filename offset.
- *                      If empty string or if it's ending with a slash this
- *                      will be set to -1. Optional.
- * @param   poffSuff    Where to store the suffix offset (the last dot).
- *                      If empty string or if it's ending with a slash this
- *                      will be set to -1. Optional.
- */
 RTDECL(size_t) RTPathParseSimple(const char *pszPath, size_t *pcchDir, ssize_t *poffName, ssize_t *poffSuff)
 {

trunk/src/VBox/Runtime/common/path/RTPathRealDup.cpp

@@ -47 +47 @@
 
 
-/**
- * Same as RTPathReal only the result is RTStrDup()'ed.
- *
- * @returns Pointer to real path. Use RTStrFree() to free this string.
- * @returns NULL if RTPathReal() or RTStrDup() fails.
- * @param   pszPath
- */
 RTDECL(char *) RTPathRealDup(const char *pszPath)
 {

trunk/src/VBox/Runtime/common/path/comparepaths.cpp

@@ -114 +114 @@
 
 
-/**
- * Compares two paths.
- *
- * The comparison takes platform-dependent details into account,
- * such as:
- * <ul>
- * <li>On DOS-like platforms, both separator chars (|\| and |/|) are considered
- *     to be equal.
- * <li>On platforms with case-insensitive file systems, mismatching characters
- *     are uppercased and compared again.
- * </ul>
- *
- * @returns @< 0 if the first path less than the second path.
- * @returns 0 if the first path identical to the second path.
- * @returns @> 0 if the first path greater than the second path.
- *
- * @param   pszPath1    Path to compare (must be an absolute path).
- * @param   pszPath2    Path to compare (must be an absolute path).
- *
- * @remarks File system details are currently ignored. This means that you won't
- *          get case-insensitive compares on unix systems when a path goes into a
- *          case-insensitive filesystem like FAT, HPFS, HFS, NTFS, JFS, or
- *          similar. For NT, OS/2 and similar you'll won't get case-sensitive
- *          compares on a case-sensitive file system.
- */
 RTDECL(int) RTPathCompare(const char *pszPath1, const char *pszPath2)
 {
@@ -145 +120 @@
 
 
-/**
- * Checks if a path starts with the given parent path.
- *
- * This means that either the path and the parent path matches completely, or
- * that the path is to some file or directory residing in the tree given by the
- * parent directory.
- *
- * The path comparison takes platform-dependent details into account,
- * see RTPathCompare() for details.
- *
- * @returns |true| when \a pszPath starts with \a pszParentPath (or when they
- *          are identical), or |false| otherwise.
- *
- * @param   pszPath         Path to check, must be an absolute path.
- * @param   pszParentPath   Parent path, must be an absolute path.
- *                          No trailing directory slash!
- */
 RTDECL(bool) RTPathStartsWith(const char *pszPath, const char *pszParentPath)
 {