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.
fnemitDbgNode(gz: *GenZir, node: Ast.Node.Index) !void {
// The instruction emitted here is for debugging runtime code.
// If the current block will be evaluated only during semantic analysis
// then no dbg_stmt ZIR instruction is needed.
if (gz.is_comptime) return;
constastgen = gz.astgen;
astgen.advanceSourceCursorToNode(node);
constline = astgen.source_line - gz.decl_line;
constcolumn = astgen.source_column;
tryemitDbgStmt(gz, .{ line, column });
}