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.
pubconstRenamePreserveError = error{
/// In WASI, this error may occur when the file descriptor does/// not hold the required rights to rename a resource by path relative to it.////// On Windows, this error may be returned instead of PathAlreadyExists when/// renaming a directory over an existing directory.////// On Darwin, this error may be returned when a component of either pathname/// refers to a "dataless" directory that requires materialization, and the I/O/// policy of the current thread or process disallows dataless directory materialization.AccessDenied,
PathAlreadyExists,
/// Operating system or file system does not support atomic nonreplacing/// rename.OperationUnsupported,
} || RenameError
