[PATCH] D54568: [NFC] Refine doxygen format.

[Adrian Prantl via Phabricator via llvm-commits]

aprantl added a comment.

Very much appreciated! Few tiny things inline.



================
Comment at: lib/CodeGen/LiveDebugVariables.cpp:156
 class UserValue {
-  const DILocalVariable *Variable; ///< The debug info variable we are part of.
-  const DIExpression *Expression; ///< Any complex address expression.
-  DebugLoc dl;            ///< The debug location for the variable. This is
-                          ///< used by dwarf writer to find lexical scope.
-  UserValue *leader;      ///< Equivalence class leader.
-  UserValue *next = nullptr; ///< Next value in equivalence class, or null.
+  const DILocalVariable *Variable; /// The debug info variable we are part of.
+  const DIExpression *Expression; /// Any complex address expression.
----------------
Does this do the right thing? I was under the impression that it's either

```
/// This is x.
int x;
```

or

```
int x; ///< This is x.
```


================
Comment at: lib/CodeGen/LiveDebugVariables.cpp:382
 
-  /// collectDebugValues - Collect and erase all DBG_VALUE instructions, adding
+  /// \brief Collect and erase all DBG_VALUE instructions, adding
   /// a UserValue def for each instruction.
----------------
The brief can be dropped, we are running doxygen with autobrief.


================
Comment at: lib/CodeGen/LiveDebugVariables.cpp:390
 
-  /// computeIntervals - Compute the live intervals of all user values after
+  /// \brief Compute the live intervals of all user values after
   /// collecting all their def points.
----------------
ditto


Repository:
  rL LLVM

https://reviews.llvm.org/D54568