ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for member

Browse Source
This commit is contained in:
Vinnie Falco
2013-07-08 11:08:33 -07:00
parent 394328e202
commit b1943dd6eb
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Subtrees/beast/modules/beast_core/files/beast_File.h
View File

@@ -246,20 +246,21 @@ public:
int64 hashCode64() const; 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. This will find a child file or directory of the current object.
e.g. e.g.
File ("/moose/fish").getChildFile ("foo.txt") will produce "/moose/fish/foo.txt". 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". 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. 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 @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. /** Returns a file which is in the same directory as this one.