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 › Io › Kqueue › fileWritePositional Private Function fileWritePositional Doc Source Private Function std.Io.Kqueue.fileWritePositional
fn fileWritePositional (
userdata : ?*anyopaque ,
file : File ,
header : []const u8 ,
data : []const []const u8 ,
splat : usize ,
offset : u64 ,
) File .WritePositionalError !usize Params userdata : ?*anyopaque file : File header : []const u8 data : []const []const u8 splat : usize offset : u64 File Io/Kqueue.zig: 938
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954 fn fileWritePositional (
userdata : ?*anyopaque ,
file : File ,
header : []const u8 ,
data : []const []const u8 ,
splat : usize ,
offset : u64 ,
) File .WritePositionalError !usize {
const k : *Kqueue = @ptrCast (@alignCast (userdata ));
_ = k ;
_ = file ;
_ = header ;
_ = data ;
_ = splat ;
_ = offset ;
@panic ("TODO" );
}