diff options
author | Reid Spencer <rspencer@reidspencer.com> | 2006-08-23 17:43:20 +0000 |
---|---|---|
committer | Reid Spencer <rspencer@reidspencer.com> | 2006-08-23 17:43:20 +0000 |
commit | cc2e0845c30cbbf79b51c6c39c102af27c19a1a8 (patch) | |
tree | 1aca29317919c8d43c1cad5d47c9c0002f919da1 /include/llvm/System | |
parent | ca64012ac6b21d868ccf2fcc26febd991ef2cc9c (diff) | |
download | external_llvm-cc2e0845c30cbbf79b51c6c39c102af27c19a1a8.zip external_llvm-cc2e0845c30cbbf79b51c6c39c102af27c19a1a8.tar.gz external_llvm-cc2e0845c30cbbf79b51c6c39c102af27c19a1a8.tar.bz2 |
Fix constructor documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29845 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/System')
-rw-r--r-- | include/llvm/System/Path.h | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/include/llvm/System/Path.h b/include/llvm/System/Path.h index 368fe20..55eb3e6 100644 --- a/include/llvm/System/Path.h +++ b/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) {} |