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 Struct

AvailableOption

Public Struct
std.Build.Configuration.AvailableOption
pub const AvailableOption = extern struct

Fields

name: String
description: String
type: Type
enum_options: OptionalStringList

If the type_id is enum or enum_list this provides the list of enum options

Types

File

Build/Configuration.zig:456
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
pub const AvailableOption = extern struct {
    name: String,
    description: String,
    type: Type,
    /// If the `type_id` is `enum` or `enum_list` this provides the list of enum options
    enum_options: OptionalStringList,

    pub const Type = enum(u8) {
        bool,
        int,
        float,
        @"enum",
        enum_list,
        string,
        list,
        build_id,
        lazy_path,
        lazy_path_list,
    };
}