[NFC] [MIR] Document the reg state flags

[djtodoro]

Summary

This patch adds documentation for the RegState enumeration.

[aprantl]

llvm/include/llvm/CodeGen/MachineInstrBuilder.h

45

This is personal preference, but IMO, once comments span more than one line the

enum {
  /// Register definition.
  Define = 0x2,        
  ///Not emitted register (e.g. carry, or
  ///temporary)
  Implicit = 0x4,

format is less confusing to read.

[djtodoro]

llvm/include/llvm/CodeGen/MachineInstrBuilder.h

45

It makes sense :) Thanks!

[djtodoro]

• refactor the comments

[djtodoro]

• additional formatting

llvm/include/llvm/CodeGen/MachineInstrBuilder.h

 
 namespace llvm {
 
 class MCInstrDesc;
 class MDNode;
 
 namespace RegState {
 
-  enum {
-    Define         = 0x2,
-    Implicit       = 0x4,
-    Kill           = 0x8,
-    Dead           = 0x10,
-    Undef          = 0x20,
-    EarlyClobber   = 0x40,
-    Debug          = 0x80,
-    InternalRead   = 0x100,
-    Renamable      = 0x200,
-    DefineNoRead   = Define | Undef,
-    ImplicitDefine = Implicit | Define,
-    ImplicitKill   = Implicit | Kill
-  };
+  Define = 0x2,         ///< Register definition.
+  Implicit = 0x4,       ///< Not emitted register (e.g. carry, or
+                        ///< temporary result).
+  Kill = 0x8,           ///< The last use of a register.
+  Dead = 0x10,          ///< Unused definition.
+  Undef = 0x20,         ///< Value of the register doesn't matter.
+  EarlyClobber = 0x40,  ///< Register definition happens before uses.
+  Debug = 0x80,         ///< Register 'use' is for debugging purpose.
+  InternalRead = 0x100, ///< Register reads a value that is defined
+                        ///< inside the same instruction or bundle.
+  Renamable = 0x200,    ///< Register that may be renamed.
+  DefineNoRead = Define | Undef,
+  ImplicitKill = Implicit | Kill
 
 } // end namespace RegState
 
 class MachineInstrBuilder {
   MachineFunction *MF = nullptr;
   MachineInstr *MI = nullptr;
 
 public: