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 standard library. Public Constant
pubconstSetTimestampsError = error{
/// times is NULL, or both nsec values are UTIME_NOW, and either:/// * the effective user ID of the caller does not match the owner/// of the file, the caller does not have write access to the/// file, and the caller is not privileged (Linux: does not have/// either the CAP_FOWNER or the CAP_DAC_OVERRIDE capability);/// or,/// * the file is marked immutable (see chattr(1)).AccessDenied,
/// The caller attempted to change one or both timestamps to a value/// other than the current time, or to change one of the timestamps/// to the current time while leaving the other timestamp unchanged,/// (i.e., times is not NULL, neither nsec field is UTIME_NOW,/// and neither nsec field is UTIME_OMIT) and either:/// * the caller's effective user ID does not match the owner of/// file, and the caller is not privileged (Linux: does not have/// the CAP_FOWNER capability); or,/// * the file is marked append-only or immutable (see chattr(1)).PermissionDenied,
ReadOnlyFileSystem,
} || Io.Cancelable || Io.UnexpectedError