summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2006-08-23 17:43:20 +0000
committerReid Spencer <rspencer@reidspencer.com>2006-08-23 17:43:20 +0000
commit543cc0a2bc520094052621a53cb1487797a7e7f7 (patch)
tree505bcee4a368922290d16c29515a0bc35f1ec133
parent663a005fbae25d5381d86356b126d1b2cbb6d718 (diff)
downloadbcm5719-llvm-543cc0a2bc520094052621a53cb1487797a7e7f7.tar.gz
bcm5719-llvm-543cc0a2bc520094052621a53cb1487797a7e7f7.zip
Fix constructor documentation.
llvm-svn: 29845
-rw-r--r--llvm/include/llvm/System/Path.h11
1 files changed, 4 insertions, 7 deletions
diff --git a/llvm/include/llvm/System/Path.h b/llvm/include/llvm/System/Path.h
index 368fe202316..55eb3e6c755 100644
--- a/llvm/include/llvm/System/Path.h
+++ b/llvm/include/llvm/System/Path.h
@@ -164,13 +164,10 @@ namespace sys {
/// @brief Construct an empty (and invalid) path.
Path() : path() {}
- /// This constructor will accept a std::string as a path but it verifies
- /// that the path string has a legal syntax for the operating system on
- /// which it is running. This allows a path to be taken in from outside
- /// the program. However, if the path is not valid, the Path object will
- /// be set to an empty string and an exception will be thrown.
- /// @throws std::string if \p unverified_path is not legal.
- /// @param unverified_path The path to verify and assign.
+ /// This constructor will accept a std::string as a path. No checking is
+ /// done on this path to determine if it is valid. To determine validity
+ /// of the path, use the isValid method.
+ /// @param p The path to assign.
/// @brief Construct a Path from a string.
explicit Path(const std::string& p) : path(p) {}
OpenPOWER on IntegriCloud