mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-01 08:23:21 +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
57 lines
2.2 KiB
C++
57 lines
2.2 KiB
C++
/*===-- llvm-c/BitWriter.h - BitWriter Library 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 libLLVMBitWriter.a, which *|
|
|
|* implements output of the LLVM bitcode format. *|
|
|
|* *|
|
|
|* Many exotic languages can interoperate with C code but have a harder time *|
|
|
|* with C++ due to name mangling. So in addition to C, this interface enables *|
|
|
|* tools written in such languages. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_BITCODEWRITER_H
|
|
#define LLVM_C_BITCODEWRITER_H
|
|
|
|
#include "llvm-c/Core.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup LLVMCBitWriter Bit Writer
|
|
* @ingroup LLVMC
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/*===-- Operations on modules ---------------------------------------------===*/
|
|
|
|
/** Writes a module to the specified path. Returns 0 on success. */
|
|
int LLVMWriteBitcodeToFile(LLVMModuleRef M, const char *Path);
|
|
|
|
/** Writes a module to an open file descriptor. Returns 0 on success. */
|
|
int LLVMWriteBitcodeToFD(LLVMModuleRef M, int FD, int ShouldClose,
|
|
int Unbuffered);
|
|
|
|
/** Deprecated for LLVMWriteBitcodeToFD. Writes a module to an open file
|
|
descriptor. Returns 0 on success. Closes the Handle. */
|
|
int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|