Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › zig › llvm › Builder › WipFunction › addInst Private Function addInst Doc Source 8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107 fn addInst (
self : *WipFunction ,
name : ?[]const u8 ,
instruction : Instruction ,
) Allocator .Error !Instruction .Index {
const block_instructions = &self .cursor .block .ptr (self ).instructions ;
try self .instructions .ensureUnusedCapacity (self .builder .gpa , 1 );
if (!self .strip ) {
try self .names .ensureUnusedCapacity (self .builder .gpa , 1 );
try self .debug_locations .ensureUnusedCapacity (self .builder .gpa , 1 );
}
try block_instructions .ensureUnusedCapacity (self .builder .gpa , 1 );
const final_name = if (name ) |n |
if (self .strip ) .empty else try self .builder .string (n )
else
.none ;
const index : Instruction .Index = @fromBackingInt (@intCast (self .instructions .len ));
self .instructions .appendAssumeCapacity (instruction );
if (!self .strip ) {
self .names .appendAssumeCapacity (final_name );
if (block_instructions .items .len == 0 or
!std .meta .eql (self .debug_location , self .prev_debug_location ))
{
self .debug_locations .putAssumeCapacity (index , self .debug_location );
self .prev_debug_location = self .debug_location ;
}
}
block_instructions .insertAssumeCapacity (self .cursor .instruction , index );
self .cursor .instruction += 1 ;
return index ;
}