kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Brad King 2010-08-27 10:15:16 -04:00
parent 4746365e03
commit 3bf1869c93
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Source/kwsys/SystemTools.hxx.in
View File

@ -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