Fix documentation of MachineInstr::getNumOperands

[philipginsbach]

Summary

The current documentation states "Access to explicit operands of the instruction."
This is misleading, as it also lists implicit operands:

const_mop_iterator operands_end() const { return Operands + NumOperands; }

iterator_range<mop_iterator> implicit_operands() {
  return make_range(explicit_operands().end(), operands_end());
}

[qcolombet]

Good catch!

include/llvm/CodeGen/MachineInstr.h

281 ↗

(On Diff #106855)

I believe a comment like this would be more readable.

/// \retuns the total number of operands.

[philipginsbach]

Rebased to current llvm master branch. Quentin, I have worked in your suggestion.

[qcolombet]

LGTM

llvm/trunk/include/llvm/CodeGen/MachineInstr.h

public:
   void emitError(StringRef Msg) const;
 
   /// Returns the target instruction descriptor of this MachineInstr.
   const MCInstrDesc &getDesc() const { return *MCID; }
 
   /// Returns the opcode of this MachineInstr.
   unsigned getOpcode() const { return MCID->Opcode; }
 
-  /// Access to explicit operands of the instruction.
+  /// Retuns the total number of operands.
   unsigned getNumOperands() const { return NumOperands; }
 
   const MachineOperand& getOperand(unsigned i) const {
     assert(i < getNumOperands() && "getOperand() out of range!");
     return Operands[i];
   }
   MachineOperand& getOperand(unsigned i) {
     assert(i < getNumOperands() && "getOperand() out of range!");