[PATCH] D126883: [Debuginfo][DWARF][NFC] Refactor DwarfStringPoolEntryRef.

[Adrian Prantl via Phabricator via llvm-commits]

aprantl added a comment.

Mechanically this looks fine, but I think the documentation could be improved. Could you add something to the comment of DwarfStringPoolEntryRef that explains what the two cases in the PointerUnion and their use-cases are?



================
Comment at: llvm/include/llvm/CodeGen/DwarfStringPoolEntry.h:44
+
+  // ASSUMPTION: \p Entry mustn`t be reallocated.
   DwarfStringPoolEntryRef(const StringMapEntry<DwarfStringPoolEntry> &Entry)
----------------
the formatting here is weird, it's not a doxygen comment, but uses \p...
But more importantly, it's not clear whether this describes a property of DwarfStringPoolEntryRef, a bug, or something users need to be aware of. Can you make the comment longer?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D126883/new/

https://reviews.llvm.org/D126883