summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMichael J. Spencer <bigcheesegs@gmail.com>2010-12-07 01:23:08 +0000
committerMichael J. Spencer <bigcheesegs@gmail.com>2010-12-07 01:23:08 +0000
commitad8a14f24eb3daee61c8076ff6e5a8135f4dd124 (patch)
treea99975f29b2fda551aaa5cf01f294eaf17228a07 /include
parent1522fce477f3b6b1b5812aa561ad2ff3f51eb968 (diff)
downloadllvm-ad8a14f24eb3daee61c8076ff6e5a8135f4dd124.tar.gz
llvm-ad8a14f24eb3daee61c8076ff6e5a8135f4dd124.tar.bz2
llvm-ad8a14f24eb3daee61c8076ff6e5a8135f4dd124.tar.xz
Support/PathV2: Clarify and correct documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121091 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r--include/llvm/Support/PathV2.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/llvm/Support/PathV2.h b/include/llvm/Support/PathV2.h
index e2b8751045..79760d1db5 100644
--- a/include/llvm/Support/PathV2.h
+++ b/include/llvm/Support/PathV2.h
@@ -123,17 +123,18 @@ inline reverse_iterator rend(const StringRef &path) {
/// empty \a path will result in the current directory.
///
/// /absolute/path => /absolute/path
-/// relative/../path => <current-directory>/path
+/// relative/../path => <current-directory>/relative/../path
///
/// @param path A path that is modified to be an absolute path.
/// @returns errc::success if \a path has been made absolute, otherwise a
/// platform specific error_code.
error_code make_absolute(SmallVectorImpl<char> &path);
-/// @brief Remove the last component from \a path if it exists.
+/// @brief Remove the last component from \a path unless it is the root dir.
///
/// directory/filename.cpp => directory/
/// directory/ => directory
+/// / => /
///
/// @param path A path that is modified to not have a file component.
/// @returns errc::success if \a path's file name has been removed (or there was
@@ -144,7 +145,7 @@ error_code remove_filename(SmallVectorImpl<char> &path);
///
/// ./filename.cpp => ./filename.extension
/// ./filename => ./filename.extension
-/// ./ => ? TODO: decide what semantics this has.
+/// ./ => ./.extension
///
/// @param path A path that has its extension replaced with \a extension.
/// @param extension The extension to be added. It may be empty. It may also