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 › debug › Dwarf › expression › StackMachine › run Public Function run Doc Source Public Function std.debug.Dwarf.expression.StackMachine.run
pub fn run (
self : *Self ,
expression : []const u8 ,
allocator : std .mem .Allocator ,
context : Context ,
initial_value : ?usize ,
) Error !?Value Params File debug/Dwarf/expression.zig: 286
286
287
288
289
290
291
292
293
294
295
296
297
298 pub fn run (
self : *Self ,
expression : []const u8 ,
allocator : std .mem .Allocator ,
context : Context ,
initial_value : ?usize ,
) Error !?Value {
if (initial_value ) |i | try self .stack .append (allocator , .{ .generic = i });
var stream : std .Io .Reader = .fixed (expression );
while (try self .step (&stream , allocator , context )) {}
if (self .stack .items .len == 0 ) return null ;
return self .stack .items [self .stack .items .len - 1 ];
}