From d798330f442e4d484d97fd846e72b79bfc502ae4 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Mon, 8 Jul 2013 11:08:33 -0700 Subject: [PATCH] Update documentation for member --- modules/beast_core/files/beast_File.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/beast_core/files/beast_File.h b/modules/beast_core/files/beast_File.h index 96444f8e..9566a5ec 100644 --- a/modules/beast_core/files/beast_File.h +++ b/modules/beast_core/files/beast_File.h @@ -246,20 +246,21 @@ public: int64 hashCode64() const; //============================================================================== - /** Returns a file based on a relative path. + /** Returns a file that represents a relative (or absolute) sub-path of the current one. This will find a child file or directory of the current object. e.g. File ("/moose/fish").getChildFile ("foo.txt") will produce "/moose/fish/foo.txt". + File ("/moose/fish").getChildFile ("haddock/foo.txt") will produce "/moose/fish/haddock/foo.txt". File ("/moose/fish").getChildFile ("../foo.txt") will produce "/moose/foo.txt". If the string is actually an absolute path, it will be treated as such, e.g. - File ("/moose/fish").getChildFile ("/foo.txt") will produce "/foo.txt" + File ("/moose/fish").getChildFile ("/foo.txt") will produce "/foo.txt" @see getSiblingFile, getParentDirectory, getRelativePathFrom, isAChildOf */ - File getChildFile (String relativePath) const; + File getChildFile (String relativeOrAbsolutePath) const; /** Returns a file which is in the same directory as this one.