[all-commits] [llvm/llvm-project] a1aada: [docs] Fix doxygen comments wrongly attached to th...

[Nicolás Alvarez via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: a1aada75f565fe9312e341cb850d415529a84eb2
      https://github.com/llvm/llvm-project/commit/a1aada75f565fe9312e341cb850d415529a84eb2
  Author: Nicolás Alvarez <nicolas.alvarez at gmail.com>
  Date:   2021-04-07 (Wed, 07 Apr 2021)

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

  Log Message:
  -----------
  [docs] Fix doxygen comments wrongly attached to the llvm namespace

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.

Reviewed By: thakis, mizvekov

Differential Revision: https://reviews.llvm.org/D96736