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 › AstGen › GenZir › addRestoreErrRetIndex Private Function addRestoreErrRetIndex Doc Source Private Function std.zig.AstGen.GenZir.addRestoreErrRetIndex
fn addRestoreErrRetIndex (
gz : *GenZir ,
bt : BranchTarget ,
cond : union (enum ) Params File zig/AstGen.zig: 12062
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100 fn addRestoreErrRetIndex (
gz : *GenZir ,
bt : BranchTarget ,
cond : union (enum ) {
always : void ,
if_non_error : Zir .Inst .Ref ,
},
src_node : Ast .Node .Index ,
) !Zir .Inst .Index {
switch (cond ) {
.always => return gz .addAsIndex (.{
.tag = .restore_err_ret_index_unconditional ,
.data = .{ .un_node = .{
.operand = switch (bt ) {
.ret => .none ,
.block => |b | b .toRef (),
},
.src_node = gz .nodeIndexToRelative (src_node ),
} },
}),
.if_non_error => |operand | switch (bt ) {
.ret => return gz .addAsIndex (.{
.tag = .restore_err_ret_index_fn_entry ,
.data = .{ .un_node = .{
.operand = operand ,
.src_node = gz .nodeIndexToRelative (src_node ),
} },
}),
.block => |block | return (try gz .addExtendedPayload (
.restore_err_ret_index ,
Zir .Inst .RestoreErrRetIndex {
.src_node = gz .nodeIndexToRelative (src_node ),
.block = block .toRef (),
.operand = operand ,
},
)).toIndex ().?,
},
}
}