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

[Shivam Gupta via Phabricator via llvm-commits]

xgupta added a comment.

Thanks for review.



================
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.
+///
----------------
aaron.ballman wrote:
> 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.
{F21411283}

I have uploaded a screenshot to show how it looks when we hover on this included file.


================
Comment at: llvm/include/llvm/ADT/IntrusiveRefCntPtr.h:21
+///
+///   class MyClass : public RefCountedBase<MyClass> {};
+///
----------------
aaron.ballman wrote:
> Does the code block need additional Doxygen markup?
When hover it shows - "This file defines the RefCountedBase, ThreadSafeRefCountedBase, and IntrusiveRefCntPtr classes."

>Does the code block need additional Doxygen markup?

I am also not sure.


================
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|
+///       '---------'------------------------------------'
----------------
aaron.ballman wrote:
> Just to double-check -- have you verified that ASCII art like in this comment is rendered fine in the Doxygen output?
Sorry, It is not included in any file where I can check output in a .html file in a browser.

```
xgupta at archlinux ~/llvm/llvm-project (main?) $grep -nr "Waymarking.h" . --exclude-dir=build
./clang/docs/tools/clang-formatted-files.txt:4516:llvm/include/llvm/ADT/Waymarking.h
./llvm/unittests/ADT/WaymarkingTest.cpp:9:#include "llvm/ADT/Waymarking.h"
./llvm/include/llvm/ADT/Waymarking.h:1://===- Waymarking.h - Array waymarking algorithm ----------------*- C++ -*-===//
```


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D116004