This is an archive of the discontinued LLVM Phabricator instance.

Differential D112474

[NFC][Docs] Add missing Doxygen group comments for LLVM-C
ClosedPublic

Authored by supergrecko on Oct 25 2021, 11:14 AM.

Details

Reviewers
deadalnix
lhames
Commits
rGad523cc398d1: [NFC][Docs] Add missing Doxygen group comments for LLVM-C
Summary

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)

Diff Detail

Event Timeline

supergrecko created this revision.Oct 25 2021, 11:14 AM
Herald added a reviewer: deadalnix. · View Herald TranscriptOct 25 2021, 11:14 AM
supergrecko requested review of this revision.Oct 25 2021, 11:14 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 25 2021, 11:14 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
supergrecko edited the summary of this revision. (Show Details)Oct 25 2021, 11:14 AM
Harbormaster completed remote builds in B130512: Diff 382064.Oct 25 2021, 12:30 PM
lhames accepted this revision.Nov 5 2021, 10:05 PM
lhames added a subscriber: lhames.

This is a nice change -- thanks @supergrecko!

+ Executon Engine LLJIT (LLJIT.h)
+ On-Request-Compilation (Orc.h)
+ ORC Execution (OrcEE.h)

These should be changed to just "LLJIT (LLJIT.h)" and "ExecutionEngine-based ORC Utils (OrcEE.h)".

Otherwise LGTM.

This revision is now accepted and ready to land.Nov 5 2021, 10:05 PM
supergrecko updated this revision to Diff 385252.Nov 6 2021, 2:46 AM

Rename LLJIT and OrcEE header doxygen groups




Addressing review comments:






Execution Engine LLJIT -> LLJIT

ORC Execution -> ExecutionEngine-based ORC Utils
Harbormaster completed remote builds in B132823: Diff 385252.Nov 6 2021, 2:46 AM
supergrecko updated this revision to Diff 385253.Nov 6 2021, 2:47 AM
Rename LLJIT and OrcEE header doxygen groups



Addressing review comments:



Execution Engine LLJIT -> LLJIT

ORC Execution -> ExecutionEngine-based ORC Utils
Harbormaster completed remote builds in B132824: Diff 385253.Nov 6 2021, 4:08 AM
Closed by commit rGad523cc398d1: [NFC][Docs] Add missing Doxygen group comments for LLVM-C (authored by supergrecko).  ·  Explain WhyNov 7 2021, 3:26 AM
This revision was automatically updated to reflect the committed changes.
supergrecko added a commit: rGad523cc398d1: [NFC][Docs] Add missing Doxygen group comments for LLVM-C.
Revision Contents
PathSize
llvm/
include/
llvm-c/
2 lines
2 lines
Diff 385252
llvm/include/llvm-c/LLJIT.h
Show All 26 Lines
#include "llvm-c/Error.h"
#include "llvm-c/Error.h"

#include "llvm-c/Orc.h"
#include "llvm-c/Orc.h"

#include "llvm-c/TargetMachine.h"
#include "llvm-c/TargetMachine.h"

#include "llvm-c/Types.h"
#include "llvm-c/Types.h"




LLVM_C_EXTERN_C_BEGIN
LLVM_C_EXTERN_C_BEGIN




/**
/**

 * @defgroup LLVMCExecutionEngineLLJIT Execution Engine LLJIT
 * @defgroup LLVMCExecutionEngineLLJIT LLJIT

 * @ingroup LLVMCExecutionEngine
 * @ingroup LLVMCExecutionEngine

 *
 *

 * @{
 * @{

 */
 */




/**
/**

 * A function for constructing an ObjectLinkingLayer instance to be used
 * A function for constructing an ObjectLinkingLayer instance to be used

 * by an LLJIT instance.
 * by an LLJIT instance.

▲ Show 20 Lines • Show All 208 Lines • Show Last 20 Lines
llvm/include/llvm-c/OrcEE.h
Show All 27 Lines
#include "llvm-c/ExecutionEngine.h"
#include "llvm-c/ExecutionEngine.h"

#include "llvm-c/Orc.h"
#include "llvm-c/Orc.h"

#include "llvm-c/TargetMachine.h"
#include "llvm-c/TargetMachine.h"

#include "llvm-c/Types.h"
#include "llvm-c/Types.h"




LLVM_C_EXTERN_C_BEGIN
LLVM_C_EXTERN_C_BEGIN




/**
/**

 * @defgroup LLVMCExecutionEngineORCExecutionEngine ORC Execution
 * @defgroup LLVMCExecutionEngineORCEE ExecutionEngine-based ORC Utils

 * @ingroup LLVMCExecutionEngine
 * @ingroup LLVMCExecutionEngine

 *
 *

 * @{
 * @{

 */
 */




/**
/**

 * Create a RTDyldObjectLinkingLayer instance using the standard
 * Create a RTDyldObjectLinkingLayer instance using the standard

 * SectionMemoryManager for memory management.
 * SectionMemoryManager for memory management.

Show All 22 Lines