authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-03-21 14:02:58-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-03-21 14:02:58-07:00
logc5bd19e45edfa2989909f825269c462d1bf641b7
tree7e2726005e7d15d883ef34269886794129ddf523
parent31791ae15bfa8590cb235ce9d7c87a97d5136eef

std.Build.addTest: add doc comments

closes #15009

1 files changed, 8 insertions(+), 0 deletions(-)

lib/std/Build.zig+8
...@@ -872,6 +872,14 @@ pub const TestOptions = struct {...@@ -872,6 +872,14 @@ pub const TestOptions = struct {
872 zig_lib_dir: ?LazyPath = null,872 zig_lib_dir: ?LazyPath = null,
873};873};
874874
875/// Creates an executable containing unit tests.
876///
877/// Equivalent to running the command `zig test --test-no-exec ...`.
878///
879/// **This step does not run the unit tests**. Typically, the result of this
880/// function will be passed to `addRunArtifact`, creating a `Step.Run`. These
881/// two steps are separated because they are independently configured and
882/// cached.
875pub fn addTest(b: *Build, options: TestOptions) *Step.Compile {883pub fn addTest(b: *Build, options: TestOptions) *Step.Compile {
876 return Step.Compile.create(b, .{884 return Step.Compile.create(b, .{
877 .name = options.name,885 .name = options.name,