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.
pubconstProtectMemoryError = error{
UnsupportedOperation,
/// OpenBSD will refuse to change memory protection if the specified region/// contains any pages that have previously been marked immutable using the/// `mimmutable` function.PermissionDenied,
/// The memory cannot be given the specified access. This can happen, for/// example, if you memory map a file to which you have read-only access,/// then use `protectMemory` to mark it writable.AccessDenied,
/// Changing the protection of a memory region would result in the total/// number of mappings with distinct attributes exceeding the allowed/// maximum.OutOfMemory,
} || Io.UnexpectedError