diff options
author | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-07 19:13:06 +0000 |
---|---|---|
committer | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-07 19:13:06 +0000 |
commit | bbf1c514bd832bf1306fe3e87221fd78bbc306ef (patch) | |
tree | 1dbaa1159ad8f50ee0102d1c294a6b57fd7eb44b /include/llvm-c | |
parent | 4b169cd1ebf96d8ed71505a1e1bde3764747361a (diff) | |
download | llvm-bbf1c514bd832bf1306fe3e87221fd78bbc306ef.tar.gz llvm-bbf1c514bd832bf1306fe3e87221fd78bbc306ef.tar.bz2 llvm-bbf1c514bd832bf1306fe3e87221fd78bbc306ef.tar.xz |
Cleanup some comments in the OCaml bindings.
Patch by Erick Tryzelaar.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48014 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm-c')
-rw-r--r-- | include/llvm-c/Core.h | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/include/llvm-c/Core.h b/include/llvm-c/Core.h index 9b11df5193..1c3fc9ceb4 100644 --- a/include/llvm-c/Core.h +++ b/include/llvm-c/Core.h @@ -53,15 +53,15 @@ extern "C" { typedef struct LLVMOpaqueModule *LLVMModuleRef; /** - * Each value in the LLVM IR has a type, an instance of [lltype]. See the - * llvm::Type class. + * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type + * class. */ typedef struct LLVMOpaqueType *LLVMTypeRef; /** - * When building recursive types using [refine_type], [lltype] values may become - * invalid; use [lltypehandle] to resolve this problem. See the - * llvm::AbstractTypeHolder] class. + * When building recursive types using LLVMRefineType, LLVMTypeRef values may + * become invalid; use LLVMTypeHandleRef to resolve this problem. See the + * llvm::AbstractTypeHolder class. */ typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef; @@ -165,18 +165,21 @@ void LLVMDisposeMessage(char *Message); /*===-- Modules -----------------------------------------------------------===*/ /* Create and destroy modules. */ +/** See llvm::Module::Module. */ LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID); + +/** See llvm::Module::~Module. */ void LLVMDisposeModule(LLVMModuleRef M); -/* Data layout */ +/** Data layout. See Module::getDataLayout. */ const char *LLVMGetDataLayout(LLVMModuleRef M); void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple); -/* Target triple */ +/** Target triple. See Module::getTargetTriple. */ const char *LLVMGetTarget(LLVMModuleRef M); void LLVMSetTarget(LLVMModuleRef M, const char *Triple); -/* Same as Module::addTypeName. */ +/** See Module::addTypeName. */ int LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty); void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name); @@ -198,7 +201,10 @@ void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name); * opaque type */ +/** See llvm::LLVMTypeKind::getTypeID. */ LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty); + +/** See llvm::DerivedType::refineAbstractTypeTo. */ void LLVMRefineAbstractType(LLVMTypeRef AbstractType, LLVMTypeRef ConcreteType); /* Operations on integer types */ |