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.

string

Document.string

pub fn string(doc: Document, index: StringIndex) [:0]const u8

File

lib/docs/wasm/markdown/Document.zig:191

Code

pub fn string(doc: Document, index: StringIndex) [:0]const u8 {
    const start = @backingInt(index);
    return std.mem.span(@as([*:0]u8, @ptrCast(doc.string_bytes[start..].ptr)));
}