Skip to content

Commit 349e334

Browse files
committed
chore(build): add more documentation
1 parent be7386f commit 349e334

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

build.zig

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,15 @@ pub fn build(b: *std.Build) void {
3434
// multiple modules and consumers will need to be able to specify which
3535
// module they want to access.
3636
const mod = b.addModule("ScriptHookZig", .{
37+
// The root source file is the "entry point" of this module. Users of
38+
// this module will only be able to access public declarations contained
39+
// in this file, which means that if you have declarations that you
40+
// intend to expose to consumers that were defined in other files part
41+
// of this module, you will have to make sure to re-export them from
42+
// the root file.
3743
.root_source_file = b.path("src/root.zig"),
44+
// Later on we'll use this module as the root module of a test executable
45+
// which requires us to specify a target.
3846
.target = target,
3947
.optimize = optimize,
4048
.pic = true,

0 commit comments

Comments
 (0)