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.
fnskipWhitespaceCheckEnd(self: *@This()) !bool {
self.skipWhitespace();
if (self.cursor >= self.input.len) {
// End of buffer.if (self.is_end_of_input) {
// End of everything.if (self.stackHeight() == 0) {
// We did it!returntrue;
}
returnerror.UnexpectedEndOfInput;
}
returnerror.BufferUnderrun;
}
if (self.stackHeight() == 0) returnerror.SyntaxError;
returnfalse;
}