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 › ErrorBundle › Wip › addOtherSourceLocation Private Function addOtherSourceLocation Doc Source 682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731 fn addOtherSourceLocation (
wip : *Wip ,
other : ErrorBundle ,
index : SourceLocationIndex ,
) !SourceLocationIndex {
if (index == .none ) return .none ;
const other_sl = other .getSourceLocation (index );
var ref_traces : std .ArrayList (ReferenceTrace ) = .empty ;
defer ref_traces .deinit (wip .gpa );
if (other_sl .reference_trace_len > 0 ) {
var ref_index = other .extraData (SourceLocation , @backingInt (index )).end ;
for (0 ..other_sl .reference_trace_len ) |_ | {
const other_ref_trace_ed = other .extraData (ReferenceTrace , ref_index );
const other_ref_trace = other_ref_trace_ed .data ;
ref_index = other_ref_trace_ed .end ;
const ref_trace : ReferenceTrace = if (other_ref_trace .src_loc == .none ) .{
// sentinel ReferenceTrace does not store a string index in decl_name
.decl_name = other_ref_trace .decl_name ,
.src_loc = .none ,
} else .{
.decl_name = try wip .addString (other .nullTerminatedString (other_ref_trace .decl_name )),
.src_loc = try wip .addOtherSourceLocation (other , other_ref_trace .src_loc ),
};
try ref_traces .append (wip .gpa , ref_trace );
}
}
const src_loc = try wip .addSourceLocation (.{
.src_path = try wip .addString (other .nullTerminatedString (other_sl .src_path )),
.line = other_sl .line ,
.column = other_sl .column ,
.span_start = other_sl .span_start ,
.span_main = other_sl .span_main ,
.span_end = other_sl .span_end ,
.source_line = if (other_sl .source_line != 0 )
try wip .addString (other .nullTerminatedString (other_sl .source_line ))
else
0 ,
.reference_trace_len = other_sl .reference_trace_len ,
});
for (ref_traces .items ) |ref_trace | {
try wip .addReferenceTrace (ref_trace );
}
return src_loc ;
}