Skip to content

Commit acee5db

Browse files
committed
Add doc comment to fetchAndAddDependencies
1 parent c95c100 commit acee5db

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/Package.zig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,18 @@ pub fn getName(target: *const Package, gpa: Allocator, mod: Module) ![]const u8
214214

215215
pub const build_zig_basename = "build.zig";
216216

217+
/// Fetches and adds dependencies to pkg
218+
///
219+
/// dependencies_source contains source code for the imports in the generated dependencies.zig:
220+
/// pub const some_lib = @import("HASH");
221+
/// pub const some_other_lib = @import("HASH");
222+
/// ...
223+
///
224+
/// build_roots contains source code for the build roots in the generated dependencies.zig:
225+
/// pub const some_lib = "~/.cache/zig/p/HASH";
226+
/// pub const some_other_lib = "~/.cache/zig/p/HASH";
227+
/// pub const some_non_zig_lib = "~/.cache/zig/p/HASH";
228+
/// ...
217229
pub fn fetchAndAddDependencies(
218230
pkg: *Package,
219231
deps_pkg: *Package,

0 commit comments

Comments
 (0)