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
This commit is contained in:
Gordon Henriksen 2008-03-07 19:13:06 +00:00
parent 4b169cd1eb
commit bbf1c514bd
4 changed files with 17 additions and 11 deletions

View File

@ -1,4 +1,4 @@
(*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===* (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
* *
* The LLVM Compiler Infrastructure * The LLVM Compiler Infrastructure
* *

View File

@ -1,4 +1,4 @@
(*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===* (*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===*
* *
* The LLVM Compiler Infrastructure * The LLVM Compiler Infrastructure
* *

View File

@ -1,4 +1,4 @@
/*===-- llvm_ocaml.h - LLVM Ocaml Glue --------------------------*- C++ -*-===*\ /*===-- llvm_ocaml.c - LLVM Ocaml Glue --------------------------*- C++ -*-===*\
|* *| |* *|
|* The LLVM Compiler Infrastructure *| |* The LLVM Compiler Infrastructure *|
|* *| |* *|

View File

@ -53,15 +53,15 @@ extern "C" {
typedef struct LLVMOpaqueModule *LLVMModuleRef; typedef struct LLVMOpaqueModule *LLVMModuleRef;
/** /**
* Each value in the LLVM IR has a type, an instance of [lltype]. See the * Each value in the LLVM IR has a type, an LLVMTypeRef. See the llvm::Type
* llvm::Type class. * class.
*/ */
typedef struct LLVMOpaqueType *LLVMTypeRef; typedef struct LLVMOpaqueType *LLVMTypeRef;
/** /**
* When building recursive types using [refine_type], [lltype] values may become * When building recursive types using LLVMRefineType, LLVMTypeRef values may
* invalid; use [lltypehandle] to resolve this problem. See the * become invalid; use LLVMTypeHandleRef to resolve this problem. See the
* llvm::AbstractTypeHolder] class. * llvm::AbstractTypeHolder class.
*/ */
typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef; typedef struct LLVMOpaqueTypeHandle *LLVMTypeHandleRef;
@ -165,18 +165,21 @@ void LLVMDisposeMessage(char *Message);
/*===-- Modules -----------------------------------------------------------===*/ /*===-- Modules -----------------------------------------------------------===*/
/* Create and destroy modules. */ /* Create and destroy modules. */
/** See llvm::Module::Module. */
LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID); LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID);
/** See llvm::Module::~Module. */
void LLVMDisposeModule(LLVMModuleRef M); void LLVMDisposeModule(LLVMModuleRef M);
/* Data layout */ /** Data layout. See Module::getDataLayout. */
const char *LLVMGetDataLayout(LLVMModuleRef M); const char *LLVMGetDataLayout(LLVMModuleRef M);
void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple); void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple);
/* Target triple */ /** Target triple. See Module::getTargetTriple. */
const char *LLVMGetTarget(LLVMModuleRef M); const char *LLVMGetTarget(LLVMModuleRef M);
void LLVMSetTarget(LLVMModuleRef M, const char *Triple); void LLVMSetTarget(LLVMModuleRef M, const char *Triple);
/* Same as Module::addTypeName. */ /** See Module::addTypeName. */
int LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty); int LLVMAddTypeName(LLVMModuleRef M, const char *Name, LLVMTypeRef Ty);
void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name); void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
@ -198,7 +201,10 @@ void LLVMDeleteTypeName(LLVMModuleRef M, const char *Name);
* opaque type * opaque type
*/ */
/** See llvm::LLVMTypeKind::getTypeID. */
LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty); LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty);
/** See llvm::DerivedType::refineAbstractTypeTo. */
void LLVMRefineAbstractType(LLVMTypeRef AbstractType, LLVMTypeRef ConcreteType); void LLVMRefineAbstractType(LLVMTypeRef AbstractType, LLVMTypeRef ConcreteType);
/* Operations on integer types */ /* Operations on integer types */