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.
pubconstSetLengthError = error{
/// Changing the mapping length could not be done atomically. Caller must/// use `destroy` and `create` to resize the mapping.OperationUnsupported,
/// One of the following:/// * The `File.Kind` is not `file`./// * The file is not open for reading and read access protections enabled./// * The file is not open for writing and write access protections enabled.AccessDenied,
/// The `prot` argument asks for `PROT_EXEC` but the mapped area belongs to a file on/// a filesystem that was mounted no-exec.PermissionDenied,
LockedMemoryLimitExceeded,
ProcessFdQuotaExceeded,
SystemFdQuotaExceeded,
} || Allocator.Error || File.SetLengthError