Skip to content

Commit 26a7ccf

Browse files
committed
Add documentation for LLVMBuildGEPWithNoWrapFlags and LLVMConstGEPWithNoWrapFlags
1 parent 3bfbeb5 commit 26a7ccf

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

llvm/include/llvm-c/Core.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2409,6 +2409,12 @@ LLVMValueRef LLVMConstGEP2(LLVMTypeRef Ty, LLVMValueRef ConstantVal,
24092409
LLVMValueRef LLVMConstInBoundsGEP2(LLVMTypeRef Ty, LLVMValueRef ConstantVal,
24102410
LLVMValueRef *ConstantIndices,
24112411
unsigned NumIndices);
2412+
/**
2413+
* Creates a constant GetElementPtr expression. Similar to LLVMConstGEP2, but
2414+
* allows specifying the no-wrap flags.
2415+
*
2416+
* @see llvm::ConstantExpr::getGetElementPtr()
2417+
*/
24122418
LLVMValueRef LLVMConstGEPWithNoWrapFlags(LLVMTypeRef Ty,
24132419
LLVMValueRef ConstantVal,
24142420
LLVMValueRef *ConstantIndices,
@@ -4396,6 +4402,12 @@ LLVMValueRef LLVMBuildGEP2(LLVMBuilderRef B, LLVMTypeRef Ty,
43964402
LLVMValueRef LLVMBuildInBoundsGEP2(LLVMBuilderRef B, LLVMTypeRef Ty,
43974403
LLVMValueRef Pointer, LLVMValueRef *Indices,
43984404
unsigned NumIndices, const char *Name);
4405+
/**
4406+
* Creates a GetElementPtr instruction. Similar to LLVMBuildGEP2, but allows
4407+
* specifying the no-wrap flags.
4408+
*
4409+
* @see llvm::IRBuilder::CreateGEP()
4410+
*/
43994411
LLVMValueRef LLVMBuildGEPWithNoWrapFlags(LLVMBuilderRef B, LLVMTypeRef Ty,
44004412
LLVMValueRef Pointer,
44014413
LLVMValueRef *Indices,

0 commit comments

Comments
 (0)