[PATCH] D96736: [docs] Fix doxygen comments wrongly attached to the llvm namespace

[Nicolás Alvarez via Phabricator via llvm-commits]

nicolas17 created this revision.
Herald added subscribers: dexonsmith, pengfei, hiraditya, MatzeB.
nicolas17 requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Looking at the Doxygen-generated documentation for the llvm namespace
currently shows all sorts of random comments from different parts of the
codebase. These are mostly caused by:

- File doc comments that aren't marked with \file, so they're attached to the next declaration, which is usually "namespace llvm {".
- Class doc comments placed before the namespace rather than before the class.
- Code comments before the namespace that (in my opinion) shouldn't be extracted by doxygen at all.

This commit fixes these comments. The generated doxygen documentation now
has proper docs for several classes and files, and the docs for the llvm
and llvm::detail namespaces are now empty.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D96736

Files:
  llvm/include/llvm/ADT/STLExtras.h
  llvm/include/llvm/Analysis/ValueLattice.h
  llvm/include/llvm/BinaryFormat/MsgPackDocument.h
  llvm/include/llvm/CodeGen/AccelTable.h
  llvm/include/llvm/CodeGen/GlobalISel/CSEInfo.h
  llvm/include/llvm/CodeGen/GlobalISel/Combiner.h
  llvm/include/llvm/CodeGen/GlobalISel/CombinerHelper.h
  llvm/include/llvm/CodeGen/GlobalISel/CombinerInfo.h
  llvm/include/llvm/CodeGen/GlobalISel/GISelChangeObserver.h
  llvm/include/llvm/CodeGen/GlobalISel/GISelKnownBits.h
  llvm/include/llvm/CodeGen/GlobalISel/LegalizerInfo.h
  llvm/include/llvm/CodeGen/GlobalISel/LostDebugLocObserver.h
  llvm/include/llvm/CodeGen/GlobalISel/MIPatternMatch.h
  llvm/include/llvm/CodeGen/GlobalISel/RegBankSelect.h
  llvm/include/llvm/CodeGen/LowLevelType.h
  llvm/include/llvm/CodeGen/Passes.h
  llvm/include/llvm/CodeGen/TargetPassConfig.h
  llvm/include/llvm/ExecutionEngine/Orc/SpeculateAnalyses.h
  llvm/include/llvm/IR/GlobalIFunc.h
  llvm/include/llvm/IR/PassManagerImpl.h
  llvm/include/llvm/IR/PassManagerInternal.h
  llvm/include/llvm/InterfaceStub/ELFObjHandler.h
  llvm/include/llvm/Support/BinaryStreamArray.h
  llvm/include/llvm/Support/Chrono.h
  llvm/include/llvm/Support/LowLevelTypeImpl.h
  llvm/include/llvm/Support/OptimizedStructLayout.h
  llvm/lib/CodeGen/EdgeBundles.cpp
  llvm/lib/CodeGen/LiveRangeUtils.h
  llvm/lib/CodeGen/MachineSSAUpdater.cpp
  llvm/lib/Target/Hexagon/HexagonISelDAGToDAG.cpp
  llvm/lib/Target/X86/ImmutableGraph.h
  llvm/lib/Target/X86/X86OptimizeLEAs.cpp

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D96736.323840.patch
Type: text/x-patch
Size: 25182 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210216/cce7ffd8/attachment.bin>