Doxygenize the documentation comments

src/IceLiveness.h

 //===- subzero/src/IceLiveness.h - Liveness analysis ------------*- C++ -*-===//
 //
 //                        The Subzero Code Generator
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This file declares the Liveness and LivenessNode classes,
-// which are used for liveness analysis.  The node-specific
-// information tracked for each Variable includes whether it is
-// live on entry, whether it is live on exit, the instruction number
-// that starts its live range, and the instruction number that ends
-// its live range.  At the Cfg level, the actual live intervals are
-// recorded.
-//
+///
+/// \file
+/// This file declares the Liveness and LivenessNode classes,
+/// which are used for liveness analysis.  The node-specific
+/// information tracked for each Variable includes whether it is
+/// live on entry, whether it is live on exit, the instruction number
+/// that starts its live range, and the instruction number that ends
+/// its live range.  At the Cfg level, the actual live intervals are
+/// recorded.
+///
 //===----------------------------------------------------------------------===//
 
 #ifndef SUBZERO_SRC_ICELIVENESS_H
 #define SUBZERO_SRC_ICELIVENESS_H
 
 #include "IceCfgNode.h"
 #include "IceDefs.h"
 #include "IceTypes.h"
 
 namespace Ice {
 
 class Liveness {
   Liveness() = delete;
   Liveness(const Liveness &) = delete;
   Liveness &operator=(const Liveness &) = delete;
 
   class LivenessNode {
     LivenessNode &operator=(const LivenessNode &) = delete;
 
   public:
     LivenessNode() = default;
     LivenessNode(const LivenessNode &) = default;
-    // NumLocals is the number of Variables local to this block.
+    /// NumLocals is the number of Variables local to this block.
     SizeT NumLocals = 0;
-    // NumNonDeadPhis tracks the number of Phi instructions that
-    // Inst::liveness() identified as tentatively live.  If
-    // NumNonDeadPhis changes from the last liveness pass, then liveness
-    // has not yet converged.
+    /// NumNonDeadPhis tracks the number of Phi instructions that
+    /// Inst::liveness() identified as tentatively live.  If
+    /// NumNonDeadPhis changes from the last liveness pass, then liveness
+    /// has not yet converged.
     SizeT NumNonDeadPhis = 0;
     // LiveToVarMap maps a liveness bitvector index to a Variable.  This
     // is generally just for printing/dumping.  The index should be less
     // than NumLocals + Liveness::NumGlobals.
     std::vector<Variable *> LiveToVarMap;
     // LiveIn and LiveOut track the in- and out-liveness of the global
     // variables.  The size of each vector is
     // LivenessNode::NumGlobals.
     LivenessBV LiveIn, LiveOut;
     // LiveBegin and LiveEnd track the instruction numbers of the start
@@ skipping 32 matching lines @@
     resize(Index);
     return &Nodes[Index].LiveBegin;
   }
   LiveBeginEndMap *getLiveEnd(const CfgNode *Node) {
     SizeT Index = Node->getIndex();
     resize(Index);
     return &Nodes[Index].LiveEnd;
   }
 
 private:
-  // Resize Nodes so that Nodes[Index] is valid.
+  /// Resize Nodes so that Nodes[Index] is valid.
   void resize(SizeT Index) {
     if (Index >= Nodes.size())
       Nodes.resize(Index + 1);
   }
   Cfg *Func;
   LivenessMode Mode;
   SizeT NumGlobals = 0;
-  // Size of Nodes is Cfg::Nodes.size().
+  /// Size of Nodes is Cfg::Nodes.size().
   std::vector<LivenessNode> Nodes;
-  // VarToLiveMap maps a Variable's Variable::Number to its live index
-  // within its basic block.
+  /// VarToLiveMap maps a Variable's Variable::Number to its live index
+  /// within its basic block.
   std::vector<SizeT> VarToLiveMap;
-  // LiveToVarMap is analogous to LivenessNode::LiveToVarMap, but for
-  // non-local variables.
+  /// LiveToVarMap is analogous to LivenessNode::LiveToVarMap, but for
+  /// non-local variables.
   std::vector<Variable *> LiveToVarMap;
 };
 
 } // end of namespace Ice
 
 #endif // SUBZERO_SRC_ICELIVENESS_H