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

Syntax

Public Union
std.zig.ClangCliParam.Syntax
pub const Syntax = union(enum)

Fields

flag: flag

A flag with no values.

joined: joined

An option which prefixes its (single) value.

separate: separate

An option which is followed by its value.

joined_or_separate: joined_or_separate

An option which is either joined to its (non-empty) value, or followed by its value.

joined_and_separate: joined_and_separate

An option which is both joined to its (first) value, and followed by its (second) value.

comma_joined: comma_joined

An option followed by its values, which are separated by commas.

remaining_args_joined: remaining_args_joined

An option which consumes an optional joined argument and any other remaining arguments.

multi_arg: u8

An option which is which takes multiple (separate) arguments.

File

zig.zig:1099
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
    pub const Syntax = union(enum) {
        /// A flag with no values.
        flag,
        /// An option which prefixes its (single) value.
        joined,
        /// An option which is followed by its value.
        separate,
        /// An option which is either joined to its (non-empty) value, or followed by its value.
        joined_or_separate,
        /// An option which is both joined to its (first) value, and followed by its (second) value.
        joined_and_separate,
        /// An option followed by its values, which are separated by commas.
        comma_joined,
        /// An option which consumes an optional joined argument and any other remaining arguments.
        remaining_args_joined,
        /// An option which is which takes multiple (separate) arguments.
        multi_arg: u8,
    }