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 › AstRlAnnotate › blockExpr Private Function blockExpr Doc Source Private Function std.zig.AstRlAnnotate.blockExpr
fn blockExpr (astrl : *AstRlAnnotate , parent_block : ?*Block , ri : ResultInfo , node : Ast .Node .Index , statements : []const Ast .Node .Index ) !bool Params File zig/AstRlAnnotate.zig: 769
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796 fn blockExpr (astrl : *AstRlAnnotate , parent_block : ?*Block , ri : ResultInfo , node : Ast .Node .Index , statements : []const Ast .Node .Index ) !bool {
const tree = astrl .tree ;
const lbrace = tree .nodeMainToken (node );
if (tree .isTokenPrecededByTags (lbrace , &.{ .identifier , .colon })) {
// Labeled block
var new_block : Block = .{
.parent = parent_block ,
.label = try astrl .identString (lbrace - 2 ),
.is_loop = false ,
.ri = ri ,
.consumes_res_ptr = false ,
};
for (statements ) |statement | {
_ = try astrl .expr (statement , &new_block , ResultInfo .none );
}
if (new_block .consumes_res_ptr ) {
try astrl .nodes_need_rl .putNoClobber (astrl .gpa , node , {});
}
return new_block .consumes_res_ptr ;
} else {
// Unlabeled block
for (statements ) |statement | {
_ = try astrl .expr (statement , parent_block , ResultInfo .none );
}
return false ;
}
}