[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/IntrusiveRefCntPtr.h:21
+///
+///   class MyClass : public RefCountedBase<MyClass> {};
+///
----------------
xgupta wrote:
> 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.
Sorry, It needs markup changes, I will update soon.
{F21412008}


================
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|
+///       '---------'------------------------------------'
----------------
xgupta wrote:
> 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++ -*-===//
> ```
Sorry, I didn't check it, I will update after some time. It is not rendered correctly as seen in this screenshot.
{F21411962}






Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D116004