RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2025-01-15 07:59:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix constructor documentation.

Browse Source 
llvm-svn: 29845
This commit is contained in:
Reid Spencer 2006-08-23 17:43:20 +00:00
parent 16c2934123
commit b702899462
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/llvm/System/Path.h
View File

@ -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) {}