Changeset 85383 in vbox for trunk/include/iprt

Timestamp:

Jul 18, 2020 3:26:42 PM (5 years ago)

Author:

vboxsync

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

139397

Message:

iprt/path.h: RTPathFindCommon[Ex] doc & testcase update. Testcase moved into tstRTPath.

File:

• trunk/include/iprt/path.h (modified) (2 diffs)

trunk/include/iprt/path.h

@@ -525 +525 @@
  * The paths are not made absolute or real, they are taken as given.
  *
- * @returns Length (in characters) of the common path, 0 if not found.
+ * @returns The common path length as represented by \a papszPaths[0], 0 if not
+ *          found or invalid input.
  * @param   cPaths      Number of paths in \a papszPaths.
- * @param   papszPaths  Array of paths to find common path for.
+ * @param   papszPaths  Array of paths to find common path for.  The paths must
+ *                      not contains ".." sequences, as that's too complicated
+ *                      to handle.
  */
 RTDECL(size_t) RTPathFindCommon(size_t cPaths, const char * const *papszPaths);
@@ -536 +539 @@
  * The paths are not made absolute or real, they are taken as given.
  *
- * @returns Length (in characters) of the common path, 0 if not found.
+ * @returns The common path length as represented by \a papszPaths[0], 0 if not
+ *          found or invalid input.
  * @param   cPaths      Number of paths in \a papszPaths.
- * @param   papszPaths  Array of paths to find common path for.
- * @param   fFlags      RTPATH_STR_F_STYLE_XXX. Other RTPATH_STR_F_XXX flags
- *                      will be ignored.
+ * @param   papszPaths  Array of paths to find common path for.  The paths must
+ *                      not contains ".." sequences, as that's too complicated
+ *                      to handle.
+ * @param   fFlags      RTPATH_STR_F_STYLE_XXX and RTPATH_STR_F_NO_START if
+ *                      wanted.  Other RTPATH_STR_F_XXX flags will be ignored.
  */
 RTDECL(size_t) RTPathFindCommonEx(size_t cPaths, const char * const *papszPaths, uint32_t fFlags);