Zig 0.17.0-dev (Split by item) 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.
std › Build › LazyPath › join Public Function join Doc Source 2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335 pub fn join (lazy_path : LazyPath , arena : Allocator , sub_path : []const u8 ) Allocator .Error !LazyPath {
return switch (lazy_path ) {
.src_path => |src | .{ .src_path = .{
.owner = src .owner ,
.sub_path = try fs .path .resolve (arena , &.{ src .sub_path , sub_path }),
} },
.generated => |gen | .{ .generated = .{
.index = gen .index ,
.up = gen .up ,
.sub_path = try fs .path .resolve (arena , &.{ gen .sub_path , sub_path }),
} },
.cwd_relative => |cwd_relative | .{
.cwd_relative = try fs .path .resolve (arena , &.{ cwd_relative , sub_path }),
},
.relative => |r | .{ .relative = .{
.base = r .base ,
.sub_path = try fs .path .resolve (arena , &.{ r .sub_path , sub_path }),
} },
.dependency => |dep | .{ .dependency = .{
.dependency = dep .dependency ,
.sub_path = try fs .path .resolve (arena , &.{ dep .sub_path , sub_path }),
} },
};
}