diff options
Diffstat (limited to 'Source/cmFileLock.h')
| -rw-r--r-- | Source/cmFileLock.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/Source/cmFileLock.h b/Source/cmFileLock.h index c9ab0db..6c9a7b8 100644 --- a/Source/cmFileLock.h +++ b/Source/cmFileLock.h @@ -8,17 +8,17 @@ #include <string> #if defined(_WIN32) -#include <windows.h> // HANDLE +# include <windows.h> // HANDLE #endif class cmFileLockResult; /** - * @brief Cross-platform file locking. - * @details Under the hood this class use 'fcntl' for Unix-like platforms and - * 'LockFileEx'/'UnlockFileEx' for Win32 platform. Locks are exclusive and - * advisory. - */ + * @brief Cross-platform file locking. + * @details Under the hood this class use 'fcntl' for Unix-like platforms and + * 'LockFileEx'/'UnlockFileEx' for Win32 platform. Locks are exclusive and + * advisory. + */ class cmFileLock { CM_DISABLE_COPY(cmFileLock) @@ -28,21 +28,21 @@ public: ~cmFileLock(); /** - * @brief Lock the file. - * @param timeoutSec Lock timeout. If -1 try until success or fatal error. - */ + * @brief Lock the file. + * @param timeoutSec Lock timeout. If -1 try until success or fatal error. + */ cmFileLockResult Lock(const std::string& filename, unsigned long timeoutSec); /** - * @brief Unlock the file. - */ + * @brief Unlock the file. + */ cmFileLockResult Release(); /** - * @brief Check file is locked by this class. - * @details This function helps to find double locks (deadlocks) and to do - * explicit unlocks. - */ + * @brief Check file is locked by this class. + * @details This function helps to find double locks (deadlocks) and to do + * explicit unlocks. + */ bool IsLocked(const std::string& filename) const; private: |