Explain renameParent() in function doc.

2004-12-22 09:54:43 +00:00 · 2004-12-22 09:54:43 +00:00 · 348846413d
commit 348846413d
parent 206b2dafcd
1 changed files with 2 additions and 0 deletions
--- a/src/utility/path.hpp
+++ b/src/utility/path.hpp
@ -140,6 +140,8 @@ public:
 	const bool isParentOf(const path& p) const;

 	/** Rename a parent component in the path.
+	  * Example: path("a/b/c/d").renameParent("a/b", "x/y/z")
+	  * will return path("x/y/z/c/d").
 	  *
 	  * @param oldPath old parent path
 	  * @param newPath new parent path