diff options
| author | James Dennett <jdennett@google.com> | 2012-07-02 23:17:34 +0000 |
|---|---|---|
| committer | James Dennett <jdennett@google.com> | 2012-07-02 23:17:34 +0000 |
| commit | af50aab0c317462129d73ae8000c6394c718598d (patch) | |
| tree | 4d44eb758af4c84bd0a94a855bc3e90e675b26b8 /include/clang/Basic/FileSystemStatCache.h | |
| parent | 7007c07506eb41da084deba512f54bf8bf0059c3 (diff) | |
Documentation cleanup:
* Primarily, added \brief to most of include/clang/Basic, instead of prefixing
the comments with "DeclaredName - ";
* Made some brief summaries significantly briefer;
* Fixed up some erroneous uses of \see and \arg;
* Fixed up some extraneous backslashes in \code...\endcode blocks;
* Fixed up some typos/spelling errors.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@159616 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang/Basic/FileSystemStatCache.h')
| -rw-r--r-- | include/clang/Basic/FileSystemStatCache.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/clang/Basic/FileSystemStatCache.h b/include/clang/Basic/FileSystemStatCache.h index b39755b7c1..a802c7cc74 100644 --- a/include/clang/Basic/FileSystemStatCache.h +++ b/include/clang/Basic/FileSystemStatCache.h @@ -39,9 +39,10 @@ public: CacheMissing ///< We know that the file doesn't exist. }; - /// FileSystemStatCache::get - Get the 'stat' information for the specified - /// path, using the cache to accellerate it if possible. This returns true if - /// the path does not exist or false if it exists. + /// \brief Get the 'stat' information for the specified path, using the cache + /// to accelerate it if possible. + /// + /// \returns \c true if the path does not exist or \c false if it exists. /// /// If FileDescriptor is non-null, then this lookup should only return success /// for files (not directories). If it is null this lookup should only return |