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.

formatVersion

Formats a version with the patch component omitted if it is zero, unlike SemanticVersion.format which formats all its version components regardless.

Query.formatVersion

fn formatVersion(version: SemanticVersion, gpa: Allocator, list: *ArrayList(u8)) !void

File

lib/std/Target/Query.zig:413

Code

fn formatVersion(version: SemanticVersion, gpa: Allocator, list: *ArrayList(u8)) !void {
    if (version.patch == 0) {
        try list.print(gpa, "{d}.{d}", .{ version.major, version.minor });
    } else {
        try list.print(gpa, "{d}.{d}.{d}", .{ version.major, version.minor, version.patch });
    }
}