[llvm] 01302ec - [Support][NFC] Fix a Wdocumentation warning in FileSystem.h

Bruno Ricci via llvm-commits llvm-commits at lists.llvm.org
Tue Jul 28 07:36:16 PDT 2020


Author: Bruno Ricci
Date: 2020-07-28T15:36:07+01:00
New Revision: 01302ec08609ef3b113e13aba2a08443e4fa3046

URL: https://github.com/llvm/llvm-project/commit/01302ec08609ef3b113e13aba2a08443e4fa3046
DIFF: https://github.com/llvm/llvm-project/commit/01302ec08609ef3b113e13aba2a08443e4fa3046.diff

LOG: [Support][NFC] Fix a Wdocumentation warning in FileSystem.h

Added: 
    

Modified: 
    llvm/include/llvm/Support/FileSystem.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/Support/FileSystem.h b/llvm/include/llvm/Support/FileSystem.h
index b6d2a9f3aad5..18d787a75f61 100644
--- a/llvm/include/llvm/Support/FileSystem.h
+++ b/llvm/include/llvm/Support/FileSystem.h
@@ -1140,7 +1140,7 @@ openNativeFileForRead(const Twine &Name, OpenFlags Flags = OF_None,
 /// none of other processes read or write this file, provided that all processes
 /// lock the file prior to accessing its content.
 ///
-/// @param File    The descriptor representing the file to lock.
+/// @param FD      The descriptor representing the file to lock.
 /// @param Timeout Time in milliseconds that the process should wait before
 ///                reporting lock failure. Zero value means try to get lock only
 ///                once.
@@ -1163,7 +1163,7 @@ std::error_code lockFile(int FD);
 
 /// Unlock the file.
 ///
-/// @param File The descriptor representing the file to unlock.
+/// @param FD The descriptor representing the file to unlock.
 /// @returns errc::success if lock is successfully released or platform-specific
 /// error_code otherwise.
 std::error_code unlockFile(int FD);


        


More information about the llvm-commits mailing list