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 › Parse › expectTopLevelDecl Private Function expectTopLevelDecl Doc Source Private Function std.zig.Parse.expectTopLevelDecl
fn expectTopLevelDecl (p : *Parse ) !?Node .Index Params File zig/Parse.zig: 640
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703 fn expectTopLevelDecl (p : *Parse ) !?Node .Index {
const extern_export_inline_token = p .nextToken ();
var is_extern : bool = false ;
var expect_fn : bool = false ;
var expect_var_or_fn : bool = false ;
switch (p .tokenTag (extern_export_inline_token )) {
.keyword_extern => {
_ = p .eatToken (.string_literal );
is_extern = true ;
expect_var_or_fn = true ;
},
.keyword_export => expect_var_or_fn = true ,
.keyword_inline , .keyword_noinline => expect_fn = true ,
else => p .tok_i -= 1 ,
}
const opt_fn_proto = try p .parseFnProto ();
if (opt_fn_proto ) |fn_proto | {
switch (p .tokenTag (p .tok_i )) {
.semicolon => {
p .tok_i += 1 ;
return fn_proto ;
},
.l_brace => {
if (is_extern ) {
try p .warnMsg (.{ .tag = .extern_fn_body , .token = extern_export_inline_token });
return null ;
}
const fn_decl_index = try p .reserveNode (.fn_decl );
errdefer p .unreserveNode (fn_decl_index );
const body_block = try p .parseBlock ();
return p .setNode (fn_decl_index , .{
.tag = .fn_decl ,
.main_token = p .nodeMainToken (fn_proto ),
.data = .{ .node_and_node = .{
fn_proto ,
body_block .?,
} },
});
},
else => {
// Since parseBlock only return error.ParseError on
// a missing '}' we can assume this function was
// supposed to end here.
try p .warn (.expected_semi_or_lbrace );
return null ;
},
}
}
if (expect_fn ) {
try p .warn (.expected_fn );
return error .ParseError ;
}
const thread_local_token = p .eatToken (.keyword_threadlocal );
if (try p .parseGlobalVarDecl ()) |var_decl | return var_decl ;
if (thread_local_token != null ) {
return p .fail (.expected_var_decl );
}
if (expect_var_or_fn ) {
return p .fail (.expected_var_decl_or_fn );
}
return p .fail (.expected_pub_item );
}