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.

addCMacro

Equvialent to the following C code, applied to all C source files owned by this Module:

#define name value

name and value need not live longer than the function call.

Module.addCMacro

pub fn addCMacro(m: *Module, name: []const u8, value: []const u8) void

File

lib/std/Build/Module.zig:527

Code

pub fn addCMacro(m: *Module, name: []const u8, value: []const u8) void {
    const b = m.owner;
    const graph = m.owner.graph;
    const arena = graph.arena;
    m.c_macros.append(arena, b.fmt("-D{s}={s}", .{ name, value })) catch @panic("OOM");
}