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.

fqn

Appends the fully qualified name to out.

Decl.fqn

pub fn fqn(decl: *const Decl, out: *ArrayList(u8)) Oom!void

File

lib/docs/wasm/Decl.zig:193

Code

pub fn fqn(decl: *const Decl, out: *ArrayList(u8)) Oom!void {
    try decl.append_path(out);
    if (decl.parent != .none) {
        try append_parent_ns(out, decl.parent);
        try out.appendSlice(gpa, decl.extra_info().name);
    } else {
        out.items.len -= 1; // remove the trailing '.'
    }
}