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 library itself.

isObjectKeyExpected

Stringify.isObjectKeyExpected

fn isObjectKeyExpected(self: *const Stringify) ?bool

File

lib/std/json/Stringify.zig:202

Code

fn isObjectKeyExpected(self: *const Stringify) ?bool {
    switch (safety_checks) {
        .checked_to_fixed_depth => return self.indent_level > 0 and
            BitStack.peekWithState(&self.nesting_stack, self.indent_level) == @backingInt(IndentationMode.object) and
            self.next_punctuation != .colon,
        .assumed_correct => return null,
    }
}