[llvm] 1aa7b83 - [Docs][NFC] Add doxygen comment for AtomicExpandPass in passes.h

[Shivam Gupta via llvm-commits]

Author: Shivam Gupta
Date: 2021-09-28T17:04:44+05:30
New Revision: 1aa7b8388581d9b4a52a8d4c5d4f13d4bf6c0013

URL: https://github.com/llvm/llvm-project/commit/1aa7b8388581d9b4a52a8d4c5d4f13d4bf6c0013
DIFF: https://github.com/llvm/llvm-project/commit/1aa7b8388581d9b4a52a8d4c5d4f13d4bf6c0013.diff

LOG: [Docs][NFC] Add doxygen comment for AtomicExpandPass in passes.h

Added: 
    

Modified: 
    llvm/include/llvm/CodeGen/Passes.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/CodeGen/Passes.h b/llvm/include/llvm/CodeGen/Passes.h
index 09aad65464400..d5ad12fadfa06 100644
--- a/llvm/include/llvm/CodeGen/Passes.h
+++ b/llvm/include/llvm/CodeGen/Passes.h
@@ -37,6 +37,10 @@ class raw_ostream;
 
 // List of target independent CodeGen pass IDs.
 namespace llvm {
+
+  /// AtomicExpandPass - At IR level this pass replace atomic instructions with
+  /// __atomic_* library calls, or target specific instruction which implement the
+  /// same semantics in a way which better fits the target backend.
   FunctionPass *createAtomicExpandPass();
 
   /// createUnreachableBlockEliminationPass - The LLVM code generator does not