From ab82132749f24702c215545212dd83538a04cdb9 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Thu, 18 Jan 2024 21:31:45 -0700 Subject: zig build: add doc comments for functions related to options closes #18204 --- lib/std/Build/Module.zig | 3 +++ lib/std/Build/Step/Options.zig | 2 ++ 2 files changed, 5 insertions(+) (limited to 'lib/std/Build') diff --git a/lib/std/Build/Module.zig b/lib/std/Build/Module.zig index d46263849d..b481f21916 100644 --- a/lib/std/Build/Module.zig +++ b/lib/std/Build/Module.zig @@ -318,6 +318,9 @@ pub fn addAnonymousImport(m: *Module, name: []const u8, options: CreateOptions) return addImport(m, name, module); } +/// Converts a set of key-value pairs into a Zig source file, and then inserts it into +/// the Module's import table with the specified name. This makes the options importable +/// via `@import("module_name")`. pub fn addOptions(m: *Module, module_name: []const u8, options: *Step.Options) void { addImport(m, module_name, options.createModule()); } diff --git a/lib/std/Build/Step/Options.zig b/lib/std/Build/Step/Options.zig index 9748043a35..beaaf4e3a0 100644 --- a/lib/std/Build/Step/Options.zig +++ b/lib/std/Build/Step/Options.zig @@ -198,6 +198,8 @@ pub fn createModule(self: *Options) *std.Build.Module { /// deprecated: use `getOutput` pub const getSource = getOutput; +/// Returns the main artifact of this Build Step which is a Zig source file +/// generated from the key-value pairs of the Options. pub fn getOutput(self: *Options) LazyPath { return .{ .generated = &self.generated_file }; } -- cgit v1.2.3