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.

installLibraryHeaders

Forwards all headers marked for installation from lib to this artifact. When a module links with this artifact, all headers marked for installation are added to that module's include search path.

Compile.installLibraryHeaders
pub fn installLibraryHeaders(cs: *Compile, lib: *Compile) void

File

lib/std/Build/Step/Compile.zig:523

Code

pub fn installLibraryHeaders(cs: *Compile, lib: *Compile) void {
    assert(lib.kind == .lib);
    const graph = cs.step.owner.graph;
    const arena = graph.arena;
    for (lib.installed_headers.items) |installation| {
        const installation_copy = installation.dupe(graph);
        cs.installed_headers.append(arena, installation_copy) catch @panic("OOM");
        cs.addHeaderInstallationToIncludeTree(installation_copy);
        installation_copy.getSource().addStepDependencies(&cs.step);
    }
}