mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-28 22:36:05 +00:00
ad523cc398
The LLVM-C API is relatively small so we've previously added doxygen tags so it's easier to navigate the LLVM-C web docs. Over the years, more headers were added without proper doxygen tags, effectively hiding them from the main LLVM-C doxygen page. This patch adds comments to headers which did not have them. Reviewed By: lhames Differential Revision: https://reviews.llvm.org/D112474
49 lines
1.7 KiB
C
49 lines
1.7 KiB
C
/*===-- llvm-c/IRReader.h - IR Reader C Interface -----------------*- C -*-===*\
|
|
|* *|
|
|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|
|
|* Exceptions. *|
|
|
|* See https://llvm.org/LICENSE.txt for license information. *|
|
|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This file defines the C interface to the IR Reader. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_IRREADER_H
|
|
#define LLVM_C_IRREADER_H
|
|
|
|
#include "llvm-c/ExternC.h"
|
|
#include "llvm-c/Types.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* @defgroup LLVMCCoreIRReader IR Reader
|
|
* @ingroup LLVMCCore
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Read LLVM IR from a memory buffer and convert it into an in-memory Module
|
|
* object. Returns 0 on success.
|
|
* Optionally returns a human-readable description of any errors that
|
|
* occurred during parsing IR. OutMessage must be disposed with
|
|
* LLVMDisposeMessage.
|
|
*
|
|
* @see llvm::ParseIR()
|
|
*/
|
|
LLVMBool LLVMParseIRInContext(LLVMContextRef ContextRef,
|
|
LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM,
|
|
char **OutMessage);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif
|