llvm.org GIT mirror llvm / bbf1c51
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 Gordon Henriksen 12 years ago
4 changed file(s) with 17 addition(s) and 11 deletion(s). Raw diff Collapse all Expand all
None (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
0 (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
11 *
22 * The LLVM Compiler Infrastructure
33 *
None (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
0 (*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===*
11 *
22 * The LLVM Compiler Infrastructure
33 *
None /*===-- llvm_ocaml.h - LLVM Ocaml Glue --------------------------*- C++ -*-===*\
0 /*===-- llvm_ocaml.c - LLVM Ocaml Glue --------------------------*- C++ -*-===*\
11 |* *|
22 |* The LLVM Compiler Infrastructure *|
33 |* *|
5252 typedef struct LLVMOpaqueModule *LLVMModuleRef;
5353
5454 /**
55 * Each value in the LLVM IR has a type, an instance of [lltype]. See the
56 * llvm::Type class.
55 * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
56 * class.
5757 */
5858 typedef struct LLVMOpaqueType *LLVMTypeRef;
5959
6060 /**
61 * When building recursive types using [refine_type], [lltype] values may become
62 * invalid; use [lltypehandle] to resolve this problem. See the
63 * llvm::AbstractTypeHolder] class.
61 * When building recursive types using LLVMRefineType, LLVMTypeRef values may
62 * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
63 * llvm::AbstractTypeHolder class.
6464 */
6565 typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
6666
164164 /*===-- Modules -----------------------------------------------------------===*/
165165
166166 /* Create and destroy modules. */
167 /** See llvm::Module::Module. */
167168 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
169
170 /** See llvm::Module::~Module. */
168171 void LLVMDisposeModule(LLVMModuleRef M);
169172
170 /* Data layout */
173 /** Data layout. See Module::getDataLayout. */
171174 const char *LLVMGetDataLayout(LLVMModuleRef M);
172175 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
173176
174 /* Target triple */
177 /** Target triple. See Module::getTargetTriple. */
175178 const char *LLVMGetTarget(LLVMModuleRef M);
176179 void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
177180
178 /* Same as Module::addTypeName. */
181 /** See Module::addTypeName. */
179182 int LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
180183 void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
181184
197200 * opaque type
198201 */
199202
203 /** See llvm::LLVMTypeKind::getTypeID. */
200204 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
205
206 /** See llvm::DerivedType::refineAbstractTypeTo. */
201207 void LLVMRefineAbstractType(LLVMTypeRef AbstractType, LLVMTypeRef ConcreteType);
202208
203209 /* Operations on integer types */