[IR][NFC] Cleanup CmpInst signatures / code docs

[marcauberer]

Change param names to recommended upper case format for static methods in CmpInst for consistency
Implement suggestion from @dtcxzyw.

cc @dtcxzyw @tschuett

[llvmbot]

@llvm/pr-subscribers-llvm-ir

Author: Marc Auberer (marcauberer)

Changes

Change param names to recommended upper case format for static methods in CmpInst for consistency
Implement suggestion from @dtcxzyw.

cc @dtcxzyw @tschuett

---

Full diff: https://github.com/llvm/llvm-project/pull/86441.diff

1 Files Affected:

• (modified) llvm/include/llvm/IR/InstrTypes.h (+5-4)

diff --git a/llvm/include/llvm/IR/InstrTypes.h b/llvm/include/llvm/IR/InstrTypes.h
index d2b33fe9c651a1..27c67c9b24ce01 100644
--- a/llvm/include/llvm/IR/InstrTypes.h
+++ b/llvm/include/llvm/IR/InstrTypes.h
@@ -1038,7 +1038,7 @@ class CmpInst : public Instruction {
   /// the two operands. Insert the instruction into a BasicBlock right before
   /// the specified instruction.
   /// Create a CmpInst
-  static CmpInst *Create(OtherOps Op, Predicate predicate, Value *S1, Value *S2,
+  static CmpInst *Create(OtherOps Op, Predicate Pred, Value *S1, Value *S2,
                          const Twine &Name, BasicBlock::iterator InsertBefore);
 
   /// Construct a compare instruction, given the opcode, the predicate and
@@ -1047,7 +1047,7 @@ class CmpInst : public Instruction {
   /// The specified Instruction is allowed to be a dereferenced end iterator.
   /// Create a CmpInst
   static CmpInst *Create(OtherOps Op,
-                         Predicate predicate, Value *S1,
+                         Predicate Pred, Value *S1,
                          Value *S2, const Twine &Name = "",
                          Instruction *InsertBefore = nullptr);
 
@@ -1055,14 +1055,15 @@ class CmpInst : public Instruction {
   /// two operands.  Also automatically insert this instruction to the end of
   /// the BasicBlock specified.
   /// Create a CmpInst
-  static CmpInst *Create(OtherOps Op, Predicate predicate, Value *S1,
+  static CmpInst *Create(OtherOps Op, Predicate Pred, Value *S1,
                          Value *S2, const Twine &Name, BasicBlock *InsertAtEnd);
 
   /// Construct a compare instruction, given the opcode, the predicate,
   /// the two operands and the instruction to copy the flags from. Optionally
   /// (if InstBefore is specified) insert the instruction into a BasicBlock
   /// right before the specified instruction. The specified Instruction is
-  /// allowed to be a dereferenced end iterator. Create a CmpInst
+  /// allowed to be a dereferenced end iterator.
+  /// Create a CmpInst
   static CmpInst *CreateWithCopiedFlags(OtherOps Op, Predicate Pred, Value *S1,
                                         Value *S2,
                                         const Instruction *FlagsSource,

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[github-actions]

✅ With the latest revision this PR passed the Python code formatter.

[dtcxzyw]

Change param names to recommended upper case format for static methods in CmpInst for consistency Implement suggestion from @dtcxzyw.

cc @dtcxzyw @tschuett

Please don't include @ in the commit message :( I will receive an email each time someone updates their forks.