From: Reid Spencer Date: Wed, 23 Aug 2006 17:43:20 +0000 (+0000) Subject: Fix constructor documentation. X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=cc2e0845c30cbbf79b51c6c39c102af27c19a1a8;p=oota-llvm.git Fix constructor documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29845 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/include/llvm/System/Path.h b/include/llvm/System/Path.h index 368fe202316..55eb3e6c755 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) {}