Throw an exception for nonsensical arguments in some FS functions

[libs/core.git] / source / fs / utils.h

diff --git a/source/fs/utils.h b/source/fs/utils.h
index a52e37d8ed6f3321c748d5df793ce58c77b700e3..e518d35cf225da8e38692e5b09dffe2d21793af5 100644 (file)
--- 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);
 
 /// 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
 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
 int descendant_depth(const Path &path, const Path &parent);
 
 } // namespace FS