Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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 standard library. Public Union

Style

Public Union
std.Build.Step.ConfigHeader.Style
pub const Style = union(enum)

Fields

autoconf_undef: std.Build.LazyPath

A configure format supported by autotools that uses #undef foo to mark lines that can be substituted with different values.

autoconf_at: std.Build.LazyPath

A configure format supported by autotools that uses @FOO@ output variables.

cmake: std.Build.LazyPath

The configure format supported by CMake. It uses @FOO@, ${} and #cmakedefine for template substitution.

meson: std.Build.LazyPath

The configure format supported by Meson. It uses @FOO@, and #mesondefine for template substitution.

blank: blank

Instead of starting with an input file, start with nothing.

nasm: nasm

Start with nothing, like blank, and output a nasm .asm file.

Functions

pub fn getPath(style: Style) ?std.Build.LazyPath

File

Build/Step/ConfigHeader.zig:21
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
pub const Style = union(enum) {
    /// A configure format supported by autotools that uses `#undef foo` to
    /// mark lines that can be substituted with different values.
    autoconf_undef: std.Build.LazyPath,
    /// A configure format supported by autotools that uses `@FOO@` output variables.
    autoconf_at: std.Build.LazyPath,
    /// The configure format supported by CMake. It uses `@FOO@`, `${}` and
    /// `#cmakedefine` for template substitution.
    cmake: std.Build.LazyPath,
    /// The configure format supported by Meson. It uses `@FOO@`, and
    /// `#mesondefine` for template substitution.
    meson: std.Build.LazyPath,
    /// Instead of starting with an input file, start with nothing.
    blank,
    /// Start with nothing, like blank, and output a nasm .asm file.
    nasm,

    pub fn getPath(style: Style) ?std.Build.LazyPath {
        switch (style) {
            .autoconf_undef, .autoconf_at, .cmake, .meson => |s| return s,
            .blank, .nasm => return null,
        }
    }
}