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 › bitCast Private Function bitCast Doc Source Private Function std.zig.AstGen.bitCast
fn bitCast (
gz : *GenZir ,
scope : *Scope ,
ri : ResultInfo ,
node : Ast .Node .Index ,
operand_node : Ast .Node .Index ,
) InnerError !Zir .Inst .Ref Params Errors File zig/AstGen.zig: 8741
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758 fn bitCast (
gz : *GenZir ,
scope : *Scope ,
ri : ResultInfo ,
node : Ast .Node .Index ,
operand_node : Ast .Node .Index ,
) InnerError !Zir .Inst .Ref {
const cursor = maybeAdvanceSourceCursorToMainToken (gz , node );
const dest_type = try ri .rl .resultTypeForCast (gz , node , "@bitCast" );
const operand = try reachableExpr (gz , scope , .{ .rl = .none }, operand_node , node );
try emitDbgStmt (gz , cursor );
const result = try gz .addPlNode (.bitcast , node , Zir .Inst .Bin {
.lhs = dest_type ,
.rhs = operand ,
});
return rvalue (gz , ri , result , node );
}