X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Ffs%2Futils.h;h=e518d35cf225da8e38692e5b09dffe2d21793af5;hp=a52e37d8ed6f3321c748d5df793ce58c77b700e3;hb=c4bebb877ec98d518bf02152ca81930e18eda6a7;hpb=b54e273fec47af51792955143e84417b638ad2b7

diff --git a/source/fs/utils.h b/source/fs/utils.h
index a52e37d..e518d35 100644
--- a/source/fs/utils.h
+++ b/source/fs/utils.h
@@ -35,14 +35,15 @@ void unlink(const Path &path);
 /// Renames a file.  Existing file, if any, is overwritten.
 void rename(const Path &from, const Path &to);
 
-/// Makes a path relative to some base path.  That is, base/result==path.
+/** Makes a path relative to some base path.  That is, base/result==path.  Both
+paths must be either absolute or relative. */
 Path relative(const Path &path, const Path &base);
 
 /// Returns the longest prefix shared by both paths.
 Path common_ancestor(const Path &, const Path &);
 
 /** Determines how many levels a path is below another.  Returns -1 if path is
-not a descendant of parent. */
+not a descendant of parent.  Both paths must be either absolute or relative. */
 int descendant_depth(const Path &path, const Path &parent);
 
 } // namespace FS