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 › debugPointerTypeAssumeCapacity Private Function debugPointerTypeAssumeCapacity Doc Source Private Function std.zig.llvm.Builder.debugPointerTypeAssumeCapacity
fn debugPointerTypeAssumeCapacity (
self : *Builder ,
name : ?Metadata .String ,
file : ?Metadata ,
scope : ?Metadata ,
line : u32 ,
underlying_type : ?Metadata ,
size_in_bits : u64 ,
align_in_bits : u64 ,
offset_in_bits : u64 ,
) Metadata Params File zig/llvm/Builder.zig: 14118
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143 fn debugPointerTypeAssumeCapacity (
self : *Builder ,
name : ?Metadata .String ,
file : ?Metadata ,
scope : ?Metadata ,
line : u32 ,
underlying_type : ?Metadata ,
size_in_bits : u64 ,
align_in_bits : u64 ,
offset_in_bits : u64 ,
) Metadata {
assert (!self .strip );
return self .metadataSimpleAssumeCapacity (.derived_pointer_type , Metadata .DerivedType {
.name = .wrap (name ),
.file = .wrap (file ),
.scope = .wrap (scope ),
.line = line ,
.underlying_type = .wrap (underlying_type ),
.size_in_bits_lo = @truncate (size_in_bits ),
.size_in_bits_hi = @truncate (size_in_bits >> 32 ),
.align_in_bits_lo = @truncate (align_in_bits ),
.align_in_bits_hi = @truncate (align_in_bits >> 32 ),
.offset_in_bits_lo = @truncate (offset_in_bits ),
.offset_in_bits_hi = @truncate (offset_in_bits >> 32 ),
});
}