diff options
Diffstat (limited to 'include/clang/Basic/FileSystemStatCache.h')
| -rw-r--r-- | include/clang/Basic/FileSystemStatCache.h | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/include/clang/Basic/FileSystemStatCache.h b/include/clang/Basic/FileSystemStatCache.h index 96a2f90..a802c7c 100644 --- a/include/clang/Basic/FileSystemStatCache.h +++ b/include/clang/Basic/FileSystemStatCache.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the FileSystemStatCache interface. -// +/// +/// \file +/// \brief Defines the FileSystemStatCache interface. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_FILESYSTEMSTATCACHE_H @@ -34,13 +35,14 @@ public: virtual ~FileSystemStatCache() {} enum LookupResult { - CacheExists, //< We know the file exists and its cached stat data. - CacheMissing //< We know that the file doesn't exist. + CacheExists, ///< We know the file exists and its cached stat data. + 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 |
