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 library itself.
pubconstWritePositionalError = error{
DiskQuota,
FileTooBig,
InputOutput,
NoSpaceLeft,
DeviceBusy,
/// File descriptor does not hold the required rights to write to it.AccessDenied,
PermissionDenied,
/// File is an unconnected socket, or closed its read end.BrokenPipe,
/// Insufficient kernel memory to read from in_fd.SystemResources,
/// The process cannot access the file because another process has locked/// a portion of the file. Windows-only.LockViolation,
/// Non-blocking has been enabled and this operation would block.WouldBlock,
/// This error occurs when a device gets disconnected before or mid-flush/// while it's being written to - errno(6): No such device or address.NoDevice,
FileBusy,
/// This file cannot be written positionally.Unseekable,
/// File was not opened with write capability.NotOpenForWriting,
} || Io.Cancelable || Io.UnexpectedError