[PATCH] D116004: [NFC] Add missing doxygen file tag in llvm/include/llvm/ADT/ headers

[Aaron Ballman via Phabricator via llvm-commits]

aaron.ballman added a comment.

Thanks for this! Generally LG, but I did have some questions.



================
Comment at: llvm/include/llvm/ADT/BreadthFirstIterator.h:13-14
+///
+/// bf_begin/bf_end/bf_iterator
+///   * Normal breadth-first iteration - visit a graph level-by-level.
+///
----------------
I'm not super familiar with Doxygen, so please forgive me in this is a silly question, but how well does Doxygen handle multiple paragraphs of text? I was assuming this would need some sort of delimiters for this situation.


================
Comment at: llvm/include/llvm/ADT/DepthFirstIterator.h:15
+///   * Normal depth-first iteration - visit a node and then all of its 
+///     children.
+///
----------------
I'm not certain what clang-format is after here -- can you investigate?


================
Comment at: llvm/include/llvm/ADT/IntervalMap.h:32
+/// IntervalMap is optimized for small key and value objects, 4 or 8 bytes 
+/// each is the optimal size. For large objects use std::map instead.
 //
----------------
Same here about clang-format.


================
Comment at: llvm/include/llvm/ADT/IntrusiveRefCntPtr.h:21
+///
+///   class MyClass : public RefCountedBase<MyClass> {};
+///
----------------
Does the code block need additional Doxygen markup?


================
Comment at: llvm/include/llvm/ADT/Waymarking.h:16-19
+/// bits: |   n-1   |             n-2 ... 0              |
+///       .---------.------------------------------------.
+///       |Stop Mask|(2^(n-1))-ary numeric system - digit|
+///       '---------'------------------------------------'
----------------
Just to double-check -- have you verified that ASCII art like in this comment is rendered fine in the Doxygen output?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D116004