[PATCH] D112474: [NFC][Docs] Add missing Doxygen group comments for LLVM-C

[Mats Larsen via Phabricator via llvm-commits]

supergrecko created this revision.
Herald added a reviewer: deadalnix.
supergrecko requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

The LLVM-C API is relatively small, so we've previously added doxygen group tags
so it's easy to navigate LLVM-C on the web documentation. Over the years, more
LLVM-C headers have been added without the doxygen tags, effectively hiding
them from the "LLVM-C: C Interface to LLVM" doxygen page.

This patch adds doxygen group comments to the headers which did not have them
previously. The new items added to the doxygen group tree looks like this:

| -- LLVM-C |
|

  + Linker (Linker.h)
  + Error Handling (Error.h, ErrorHandling.h)
  |-- Core
    + Comdats (Comdat.h)
    + Debug Information (DebugInfo.h)
    + New Pass Manager (Transforms/PassBuilder.h)
    + IR Reader (IRReader.h)
    + Pass Registry (moved from root)
    + Pass Manager (moved from root)
  |-- Execution Engine
    + Executon Engine LLJIT (LLJIT.h)
    + On-Request-Compilation (Orc.h)
    + ORC Execution (OrcEE.h)
  - Pass Registry
  - Pass Manager

The groups Pass Registry and PassManager have been moved into LLVMCCore as their
names hinted. (LLVMCCorePassRegistry and LLVMCCorePassManager) I believe the
original author forgot the doxygen ingroup directive which is why they were
misplaced at root.

In addition to this, the following groups have been updated:

- Core (Support.h has been added to the group)
- Disassembler (DisassemblerTypes.h has been added to the group)
- Target information (TargetMachine.h has been added to the group)


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D112474

Files:
  llvm/include/llvm-c/Comdat.h
  llvm/include/llvm-c/Core.h
  llvm/include/llvm-c/DebugInfo.h
  llvm/include/llvm-c/DisassemblerTypes.h
  llvm/include/llvm-c/Error.h
  llvm/include/llvm-c/ErrorHandling.h
  llvm/include/llvm-c/IRReader.h
  llvm/include/llvm-c/LLJIT.h
  llvm/include/llvm-c/Linker.h
  llvm/include/llvm-c/Orc.h
  llvm/include/llvm-c/OrcEE.h
  llvm/include/llvm-c/Support.h
  llvm/include/llvm-c/TargetMachine.h
  llvm/include/llvm-c/Transforms/PassBuilder.h

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D112474.382064.patch
Type: text/x-patch
Size: 7818 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211025/1dd4b618/attachment.bin>