mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-23 03:02:36 +01: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
82 lines
2.8 KiB
C++
82 lines
2.8 KiB
C++
/*===-- IPO.h - Interprocedural Transformations 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 libLLVMIPO.a, which implements *|
|
|
|* various interprocedural transformations of the LLVM IR. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_TRANSFORMS_IPO_H
|
|
#define LLVM_C_TRANSFORMS_IPO_H
|
|
|
|
#include "llvm-c/Core.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup LLVMCTransformsIPO Interprocedural transformations
|
|
* @ingroup LLVMCTransforms
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/** See llvm::createArgumentPromotionPass function. */
|
|
void LLVMAddArgumentPromotionPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createConstantMergePass function. */
|
|
void LLVMAddConstantMergePass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createDeadArgEliminationPass function. */
|
|
void LLVMAddDeadArgEliminationPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createFunctionAttrsPass function. */
|
|
void LLVMAddFunctionAttrsPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createFunctionInliningPass function. */
|
|
void LLVMAddFunctionInliningPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createAlwaysInlinerPass function. */
|
|
void LLVMAddAlwaysInlinerPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createGlobalDCEPass function. */
|
|
void LLVMAddGlobalDCEPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createGlobalOptimizerPass function. */
|
|
void LLVMAddGlobalOptimizerPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createIPConstantPropagationPass function. */
|
|
void LLVMAddIPConstantPropagationPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createPruneEHPass function. */
|
|
void LLVMAddPruneEHPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createIPSCCPPass function. */
|
|
void LLVMAddIPSCCPPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createInternalizePass function. */
|
|
void LLVMAddInternalizePass(LLVMPassManagerRef, unsigned AllButMain);
|
|
|
|
/** See llvm::createStripDeadPrototypesPass function. */
|
|
void LLVMAddStripDeadPrototypesPass(LLVMPassManagerRef PM);
|
|
|
|
/** See llvm::createStripSymbolsPass function. */
|
|
void LLVMAddStripSymbolsPass(LLVMPassManagerRef PM);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
#endif
|