llvm.org GIT mirror llvm / cc2e084
Fix constructor documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29845 91177308-0d34-0410-b5e6-96231b3b80d8 Reid Spencer 14 years ago
1 changed file(s) with 4 addition(s) and 7 deletion(s). Raw diff Collapse all Expand all
163163 /// @brief Construct an empty (and invalid) path.
164164 Path() : path() {}
165165
166 /// This constructor will accept a std::string as a path but it verifies
167 /// that the path string has a legal syntax for the operating system on
168 /// which it is running. This allows a path to be taken in from outside
169 /// the program. However, if the path is not valid, the Path object will
170 /// be set to an empty string and an exception will be thrown.
171 /// @throws std::string if \p unverified_path is not legal.
172 /// @param unverified_path The path to verify and assign.
166 /// This constructor will accept a std::string as a path. No checking is
167 /// done on this path to determine if it is valid. To determine validity
168 /// of the path, use the isValid method.
169 /// @param p The path to assign.
173170 /// @brief Construct a Path from a string.
174171 explicit Path(const std::string& p) : path(p) {}
175172