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.
pubconstSymLinkError = error{
/// In WASI, this error may occur when the file descriptor does/// not hold the required rights to create a new symbolic link relative to it.AccessDenied,
PermissionDenied,
DiskQuota,
PathAlreadyExists,
FileSystem,
SymLinkLoop,
FileNotFound,
SystemResources,
NoSpaceLeft,
/// On Windows, `\\server` or `\\server\share` was not found.NetworkNotFound,
ReadOnlyFileSystem,
NotDir,
} || PathNameError || Io.Cancelable || Io.UnexpectedError