Skip to content

Commit 18862b3

Browse files
committed
update C API comments
1 parent 6fd51a1 commit 18862b3

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

llvm/include/llvm-c/Core.h

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3946,26 +3946,31 @@ const unsigned *LLVMGetIndices(LLVMValueRef Inst);
39463946
* An instruction builder represents a point within a basic block and is
39473947
* the exclusive means of building instructions using the C interface.
39483948
*
3949-
* Some insertion-position-setting functions have a "BeforeDbgRecords"
3950-
* parameter. Set to true if the insertion point should be in front of debug
3951-
* records, for example when inserting a phi. If you are trying to insert at the
3952-
* start of a block, or purposfully skip debug intrinsics to determine the
3953-
* insertion point for any other reason, then set it to true. Otherwise set it
3954-
* to false. Insertion-position-setting functions without the parameter always
3955-
* set the position after any attached debug records (i.e., as if
3956-
* "BeforeDbgRecords" is false).
3957-
*
39583949
* @{
39593950
*/
39603951

39613952
LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C);
39623953
LLVMBuilderRef LLVMCreateBuilder(void);
3954+
/**
3955+
* Set the builder poisiton before Instr but after any attached debug records,
3956+
* or if Instr is null set the position to the end of Block.
3957+
*/
39633958
void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block,
39643959
LLVMValueRef Instr);
3960+
/**
3961+
* Set the builder poisiton before Instr and any attached debug records,
3962+
* or if Instr is null set the position to the end of Block.
3963+
*/
39653964
void LLVMPositionBuilderBeforeDbgRecords(LLVMBuilderRef Builder,
39663965
LLVMBasicBlockRef Block,
39673966
LLVMValueRef Inst);
3967+
/**
3968+
* Set the builder poisiton before Instr but after any attached debug records.
3969+
*/
39683970
void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr);
3971+
/**
3972+
* Set the builder poisiton before Instr and any attached debug records.
3973+
*/
39693974
void LLVMPositionBuilderBeforeInstrAndDbgRecords(LLVMBuilderRef Builder,
39703975
LLVMValueRef Instr);
39713976
void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block);

0 commit comments

Comments
 (0)