diff options
| author | Brad King <brad.king@kitware.com> | 2010-08-27 14:15:16 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2010-08-27 14:20:02 (GMT) |
| commit | 3bf1869c93daf131e8040e88f20986cf01bb9779 (patch) | |
| tree | bc3fb6e4e6470548e0a32c8c83b98ce7ed2cbd3b /Source/kwsys/SystemTools.hxx.in | |
| parent | 4746365e0312693b754e59f51e692285c046fa89 (diff) | |
| download | CMake-3bf1869c93daf131e8040e88f20986cf01bb9779.zip CMake-3bf1869c93daf131e8040e88f20986cf01bb9779.tar.gz CMake-3bf1869c93daf131e8040e88f20986cf01bb9779.tar.bz2 | |
KWSys: Improve SplitPath method documentation
Document explicitly that the first component always exists. Fix the
documentation of SplitPathRootComponent to note that home directory
roots (~/ and ~u/) always have a trailing slash.
Diffstat (limited to 'Source/kwsys/SystemTools.hxx.in')
| -rw-r--r-- | Source/kwsys/SystemTools.hxx.in | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Source/kwsys/SystemTools.hxx.in b/Source/kwsys/SystemTools.hxx.in index ec70320..cf47923 100644 --- a/Source/kwsys/SystemTools.hxx.in +++ b/Source/kwsys/SystemTools.hxx.in @@ -372,8 +372,8 @@ public: * "c:/" = Windows full path (can be any drive letter) * "c:" = Windows drive-letter relative path (can be any drive letter) * "//" = Network path - * "~" = Home path for current user - * "~u" = Home path for user 'u' + * "~/" = Home path for current user + * "~u/" = Home path for user 'u' * "" = Relative path * * A pointer to the rest of the path after the root component is @@ -385,7 +385,7 @@ public: /** * Split a path name into its basic components. The first component - * is one of the roots returned by SplitPathRootComponent. + * always exists and is the root returned by SplitPathRootComponent. * The remaining components form the path. If there is a trailing * slash then the last component is the empty string. The * components can be recombined as "c[0]c[1]/c[2]/.../c[n]" to |