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. Private Function
fnstratOk(it: *constStackIterator, allow_unsafe: bool) bool {
returnswitch (it.*) {
.ctx_first, .di => true,
// If we omitted frame pointers from *this* compilation, FP unwinding would crash// immediately regardless of anything. But FPs could also be omitted from a different// linked object, so it's not guaranteed to be safe, unless the target specifically// requires it.
.fp => switch (fp_usability) {
.useless => false,
.unsafe => allow_unsafeand !builtin.omit_frame_pointer,
.safe => !builtin.omit_frame_pointer,
.ideal => true,
},
};
}
Whether the current unwind strategy is allowed given
allow_unsafe.