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 › os › windows › FILE › RENAME_INFORMATION › init Public Function init Doc Source Public Function std.os.windows.FILE.RENAME_INFORMATION.init
pub fn init (opts : struct Params opts : struct { Flags : FLAGS = .{}, RootDirectory : ?HANDLE = null , FileName : []const WCHAR , } File os/windows.zig: 440
440
441
442
443
444
445
446
447
448
449
450
451
452
453 pub fn init (opts : struct {
Flags : FLAGS = .{},
RootDirectory : ?HANDLE = null ,
FileName : []const WCHAR ,
}) RENAME_INFORMATION {
var fri : RENAME_INFORMATION = .{
.Flags = opts .Flags ,
.RootDirectory = opts .RootDirectory ,
.FileNameLength = @intCast (@sizeOf (WCHAR ) * opts .FileName .len ),
.FileName = undefined ,
};
@memcpy (fri .FileName [0 ..opts .FileName .len ], opts .FileName );
return fri ;
}