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. Public Constant
pubconstCreateFileAtomicError = error{
NoDevice,
/// On Windows, `\\server` or `\\server\share` was not found.NetworkNotFound,
/// On Windows, antivirus software is enabled by default. It can be/// disabled, but Windows Update sometimes ignores the user's preference/// and re-enables it. When enabled, antivirus software on Windows/// intercepts file system operations and makes them significantly slower/// in addition to possibly failing with this error code.AntivirusInterference,
/// In WASI, this error may occur when the file descriptor does/// not hold the required rights to open a new resource relative to it.AccessDenied,
PermissionDenied,
SymLinkLoop,
ProcessFdQuotaExceeded,
SystemFdQuotaExceeded,
/// Either:/// * One of the path components does not exist./// * Cwd was used, but cwd has been deleted./// * The path associated with the open directory handle has been deleted.FileNotFound,
/// Insufficient kernel memory was available.SystemResources,
/// A new path cannot be created because the device has no room for the new file.NoSpaceLeft,
/// A component used as a directory in the path was not, in fact, a directory.NotDir,
WouldBlock,
ReadOnlyFileSystem,
/// The file attempted to be created is a running executable.FileBusy,
} || Io.Dir.PathNameError || Io.Cancelable || Io.UnexpectedError