Zig 0.17.0-dev (Split by item)

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.

lessThanComparison

If a min heap is constructed from slice {5, 8, 2, 9, 7, 1, 4, 4} using this method, then the elements will be in order: {1, 2, 4, 4, 5, 7, 8, 9}

priority_dequeue.lessThanComparison

fn lessThanComparison(context: void, a: u32, b: u32) Order

File

lib/std/priority_dequeue.zig:455

Code

fn lessThanComparison(context: void, a: u32, b: u32) Order {
    _ = context;
    return std.math.order(a, b);
}