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

[Aaron Ballman via Phabricator via llvm-commits]

aaron.ballman added inline comments.


================
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:
> xgupta wrote:
> > aaron.ballman wrote:
> > > xgupta wrote:
> > > > 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}
> > > > 
> > > > 
> > > > 
> > > > 
> > > Is this now rendering properly?
> > Yes. See - {F21892118}{F21892111} 
> Awesome! FWIW, that we had to think about this at all spurred me to create https://reviews.llvm.org/D118467.
Just to warn you, that review above landed, so you'll get merge conflicts with your changes here. No need to have additional review for them though, you're free to land whenever.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D116004