[llvm] r363914 - [NFC] Update documentation for AtomicCmpXchgInst

[Serge Guelton via llvm-commits]

Author: serge_sans_paille
Date: Thu Jun 20 02:37:52 2019
New Revision: 363914

URL: http://llvm.org/viewvc/llvm-project?rev=363914&view=rev
Log:
[NFC] Update documentation for AtomicCmpXchgInst

Fix bz#42325

Modified:
    llvm/trunk/include/llvm/IR/Instructions.h

Modified: llvm/trunk/include/llvm/IR/Instructions.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/IR/Instructions.h?rev=363914&r1=363913&r2=363914&view=diff
==============================================================================
--- llvm/trunk/include/llvm/IR/Instructions.h (original)
+++ llvm/trunk/include/llvm/IR/Instructions.h Thu Jun 20 02:37:52 2019
@@ -521,9 +521,11 @@ private:
 //                                AtomicCmpXchgInst Class
 //===----------------------------------------------------------------------===//
 
-/// an instruction that atomically checks whether a
+/// An instruction that atomically checks whether a
 /// specified value is in a memory location, and, if it is, stores a new value
-/// there.  Returns the value that was loaded.
+/// there. The value returned by this instruction is a pair containing the
+/// original value as first element, and an i1 indicating success (true) or
+/// failure (false) as second element.
 ///
 class AtomicCmpXchgInst : public Instruction {
   void Init(Value *Ptr, Value *Cmp, Value *NewVal,