Documentation: Fixed apidoc for String::expandNativePath()

skyjake · Nov 5, 2012 · 5612895 · 5612895
1 parent 856c02d
commit 5612895
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/doomsday/libdeng2/include/de/data/string.h b/doomsday/libdeng2/include/de/data/string.h
@@ -176,8 +176,15 @@ class DENG2_PUBLIC String : public QString
      * Expands the relative path directives '>' and '}' at the start of
      * the path, replacing them with the application path.
      *
-     * @note Also handles '~' on UNIX-based platforms so that the user
-     *       specific home path (or
+     * @note Also handles '~' on UNIX-based platforms so that a user
+     *       specific home path (taken from passwd) may also be used.
+     *
+     * @param didExpand  If specified, this value will be set to true if
+     *                   path expansion was done.
+     *
+     * @return A copy of the path with directives expanded.
+     *
+     * @throws UnknownUserError  If the user is not known.
      *
      * @see App::nativeBasePath()
      */