[PATCH] D27782: [codegen] Add generic functions to skip debug values.
Matthias Braun via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Wed Dec 14 16:46:08 PST 2016
MatzeB added inline comments.
Comment at: include/llvm/CodeGen/MachineBasicBlock.h:809
+/// Increment \p It until it points to a non-debug instruction or to \p End.
+/// @param It Iterator to increment
+/// @param End Iterator that points to end. Will be compared to It
> Nitpick: we use \param instead of @param
Not wanting to be too nitpicky or criticize for actually writing good documentation, but I can't stop thinking that some cases where a comment reads like `\param It The iterator to use` is not that far off from a comment like `int i; // an integer variable`, which doesn't really add much value. So I often simply leave out the \param stuff when things are sufficiently clearly explained in the description part.
More information about the llvm-commits