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. Private Function
fnpartitionEqual(a: usize, b: usize, pivot: usize, context: anytype) usize {
// move pivot to the first placecontext.swap(a, pivot);
vari = a + 1;
varj = b - 1;
while (true) {
while (i <= jand !context.lessThan(a, i)) i += 1;
while (i <= jandcontext.lessThan(a, j)) j -= 1;
if (i > j) break;
context.swap(i, j);
i += 1;
j -= 1;
}
returni;
}
partitions items into elements equal to
items[pivot]followed by elements greater thanitems[pivot].it assumed that
items[a..b]does not contain elements smaller than theitems[pivot].