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 › Cache › Path › openFile Public Function openFile Doc Source Public Function std.Build.Cache.Path.openFile
pub fn openFile (p : Path , io : Io , sub_path : []const u8 , flags : Io .Dir .OpenFileOptions ) !Io .File Params p : Path io : Io sub_path : []const u8 flags : Io .Dir .OpenFileOptions File Build/Cache/Path.zig: 61
61
62
63
64
65
66
67
68
69 pub fn openFile (p : Path , io : Io , sub_path : []const u8 , flags : Io .Dir .OpenFileOptions ) !Io .File {
var buf : [Io .Dir .max_path_bytes ]u8 = undefined ;
const joined_path = if (p .sub_path .len == 0 ) sub_path else p : {
break :p std .mem .print (&buf , "{s}" ++ Io .Dir .path .sep_str ++ "{s}" , .{
p .sub_path , sub_path ,
}) catch return error .NameTooLong ;
};
return p .root_dir .handle .openFile (io , joined_path , flags );
}