Doxygenify comments.

llvm-svn: 316466

llvm/lib/CodeGen/SelectionDAG/SDNodeDbgValue.h

@@ -25,24 +25,23 @@ class DIExpression;
 class SDNode;
 class Value;
 
-/// SDDbgValue - Holds the information from a dbg_value node through SDISel.
+/// Holds the information from a dbg_value node through SDISel.
 /// We do not use SDValue here to avoid including its header.
-
 class SDDbgValue {
 public:
   enum DbgValueKind {
-    SDNODE = 0,             // value is the result of an expression
-    CONST = 1,              // value is a constant
-    FRAMEIX = 2             // value is contents of a stack location
+    SDNODE = 0,             ///< Value is the result of an expression.
+    CONST = 1,              ///< Value is a constant.
+    FRAMEIX = 2             ///< Value is contents of a stack location.
   };
 private:
   union {
     struct {
-      SDNode *Node;         // valid for expressions
-      unsigned ResNo;       // valid for expressions
+      SDNode *Node;         ///< Valid for expressions.
+      unsigned ResNo;       ///< Valid for expressions.
     } s;
-    const Value *Const;     // valid for constants
-    unsigned FrameIx;       // valid for stack objects
+    const Value *Const;     ///< Valid for constants.
+    unsigned FrameIx;       ///< Valid for stack objects.
   } u;
   DIVariable *Var;
   DIExpression *Expr;
@@ -53,7 +52,7 @@ private:
   bool Invalid = false;
 
 public:
-  // Constructor for non-constants.
+  /// Constructor for non-constants.
   SDDbgValue(DIVariable *Var, DIExpression *Expr, SDNode *N, unsigned R,
              bool indir, DebugLoc dl, unsigned O)
       : Var(Var), Expr(Expr), DL(std::move(dl)), Order(O), IsIndirect(indir) {
@@ -62,7 +61,7 @@ public:
     u.s.ResNo = R;
   }
 
-  // Constructor for constants.
+  /// Constructor for constants.
   SDDbgValue(DIVariable *Var, DIExpression *Expr, const Value *C, DebugLoc dl,
              unsigned O)
       : Var(Var), Expr(Expr), DL(std::move(dl)), Order(O), IsIndirect(false) {
@@ -70,7 +69,7 @@ public:
     u.Const = C;
   }
 
-  // Constructor for frame indices.
+  /// Constructor for frame indices.
   SDDbgValue(DIVariable *Var, DIExpression *Expr, unsigned FI, DebugLoc dl,
              unsigned O)
       : Var(Var), Expr(Expr), DL(std::move(dl)), Order(O), IsIndirect(false) {
@@ -78,40 +77,40 @@ public:
     u.FrameIx = FI;
   }
 
-  // Returns the kind.
+  /// Returns the kind.
   DbgValueKind getKind() const { return kind; }
 
-  // Returns the DIVariable pointer for the variable.
+  /// Returns the DIVariable pointer for the variable.
   DIVariable *getVariable() const { return Var; }
 
-  // Returns the DIExpression pointer for the expression.
+  /// Returns the DIExpression pointer for the expression.
   DIExpression *getExpression() const { return Expr; }
 
-  // Returns the SDNode* for a register ref
+  /// Returns the SDNode* for a register ref
   SDNode *getSDNode() const { assert (kind==SDNODE); return u.s.Node; }
 
-  // Returns the ResNo for a register ref
+  /// Returns the ResNo for a register ref
   unsigned getResNo() const { assert (kind==SDNODE); return u.s.ResNo; }
 
-  // Returns the Value* for a constant
+  /// Returns the Value* for a constant
   const Value *getConst() const { assert (kind==CONST); return u.Const; }
 
-  // Returns the FrameIx for a stack object
+  /// Returns the FrameIx for a stack object
   unsigned getFrameIx() const { assert (kind==FRAMEIX); return u.FrameIx; }
 
-  // Returns whether this is an indirect value.
+  /// Returns whether this is an indirect value.
   bool isIndirect() const { return IsIndirect; }
 
-  // Returns the DebugLoc.
+  /// Returns the DebugLoc.
   DebugLoc getDebugLoc() const { return DL; }
 
-  // Returns the SDNodeOrder.  This is the order of the preceding node in the
-  // input.
+  /// Returns the SDNodeOrder.  This is the order of the preceding node in the
+  /// input.
   unsigned getOrder() const { return Order; }
 
-  // setIsInvalidated / isInvalidated - Setter / getter of the "Invalidated"
-  // property. A SDDbgValue is invalid if the SDNode that produces the value is
-  // deleted.
+  /// setIsInvalidated / isInvalidated - Setter / getter of the "Invalidated"
+  /// property. A SDDbgValue is invalid if the SDNode that produces the value is
+  /// deleted.
   void setIsInvalidated() { Invalid = true; }
   bool isInvalidated() const { return Invalid; }
 };