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.

create

CheckFile.create

pub fn create(owner: *std.Build, file: std.Build.LazyPath, options: Options) *CheckFile

File

lib/std/Build/Step/CheckFile.zig:25

Code

pub fn create(owner: *std.Build, file: std.Build.LazyPath, options: Options) *CheckFile {
    const graph = owner.graph;
    const check_file = graph.create(CheckFile);
    check_file.* = .{
        .step = .init(.{
            .tag = base_tag,
            .name = "CheckFile",
            .owner = owner,
        }),
        .file = file.dupe(graph),
        .expected_matches = graph.addBytesList(options.expected_matches),
        .expected_exact = if (options.expected_exact) |b| graph.addBytes(b) else null,
        .max_bytes = options.max_bytes,
    };
    file.addStepDependencies(&check_file.step);
    return check_file;
}