mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-12-26 13:36:28 +00:00
43c1c2e000
This gives a lot of love to the docs for the C API. Like Clang's documentation, the C API is now organized into a Doxygen "module" (LLVMC). Each C header file is a child of the main module. Some modules (like Core) have a hierarchy of there own. The produced documentation is thus better organized (before everything was in one monolithic list). This patch also includes a lot of new documentation for APIs in Core.h. It doesn't document them all, but is better than none. Function docs are missing @param and @return annotation, but the documentation body now commonly provides help details (like the expected llvm::Value sub-type to expect). llvm-svn: 153157
55 lines
2.0 KiB
C
55 lines
2.0 KiB
C
/*===-- llvm-c/Initialization.h - Initialization C Interface ------*- C -*-===*\
|
|
|* *|
|
|
|* The LLVM Compiler Infrastructure *|
|
|
|* *|
|
|
|* This file is distributed under the University of Illinois Open Source *|
|
|
|* License. See LICENSE.TXT for details. *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header declares the C interface to LLVM initialization routines, *|
|
|
|* which must be called before you can use the functionality provided by *|
|
|
|* the corresponding LLVM library. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_INITIALIZEPASSES_H
|
|
#define LLVM_C_INITIALIZEPASSES_H
|
|
|
|
#include "llvm-c/Core.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup LLVMCInitialization Initialization Routines
|
|
* @ingroup LLVMC
|
|
*
|
|
* This module contains routines used to initialize the LLVM system.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
void LLVMInitializeCore(LLVMPassRegistryRef R);
|
|
void LLVMInitializeTransformUtils(LLVMPassRegistryRef R);
|
|
void LLVMInitializeScalarOpts(LLVMPassRegistryRef R);
|
|
void LLVMInitializeVectorization(LLVMPassRegistryRef R);
|
|
void LLVMInitializeInstCombine(LLVMPassRegistryRef R);
|
|
void LLVMInitializeIPO(LLVMPassRegistryRef R);
|
|
void LLVMInitializeInstrumentation(LLVMPassRegistryRef R);
|
|
void LLVMInitializeAnalysis(LLVMPassRegistryRef R);
|
|
void LLVMInitializeIPA(LLVMPassRegistryRef R);
|
|
void LLVMInitializeCodeGen(LLVMPassRegistryRef R);
|
|
void LLVMInitializeTarget(LLVMPassRegistryRef R);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|