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 › addFailedDeclaration Private Function addFailedDeclaration Doc Source Private Function std.zig.AstGen.addFailedDeclaration
fn addFailedDeclaration (
wip_decls : *WipDecls ,
gz : *GenZir ,
kind : Zir .Inst .Declaration .Unwrapped .Kind ,
name : Zir .NullTerminatedString ,
src_node : Ast .Node .Index ,
is_pub : bool ,
) !void Params wip_decls : *WipDecls gz : *GenZir kind : Zir .Inst .Declaration .Unwrapped .Kind name : Zir .NullTerminatedString src_node : Ast .Node .Index is_pub : bool File zig/AstGen.zig: 13387
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425 fn addFailedDeclaration (
wip_decls : *WipDecls ,
gz : *GenZir ,
kind : Zir .Inst .Declaration .Unwrapped .Kind ,
name : Zir .NullTerminatedString ,
src_node : Ast .Node .Index ,
is_pub : bool ,
) !void {
const decl_inst = try gz .makeDeclaration (src_node );
wip_decls .nextDecl (decl_inst );
var dummy_gz = gz .makeSubBlock (&gz .base );
var value_gz = gz .makeSubBlock (&gz .base ); // scope doesn't matter here
_ = try value_gz .add (.{
.tag = .extended ,
.data = .{ .extended = .{
.opcode = .astgen_error ,
.small = undefined ,
.operand = undefined ,
} },
});
try setDeclaration (decl_inst , .{
.src_hash = @splat (0 ), // use a fixed hash to represent an AstGen failure; we don't care about source changes if AstGen still failed!
.src_line = gz .astgen .source_line ,
.src_column = gz .astgen .source_column ,
.kind = kind ,
.name = name ,
.is_pub = is_pub ,
.is_threadlocal = false ,
.linkage = .normal ,
.type_gz = &dummy_gz ,
.align_gz = &dummy_gz ,
.linksection_gz = &dummy_gz ,
.addrspace_gz = &dummy_gz ,
.value_gz = &value_gz ,
});
}