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.

Assembly.zig

File

lib/compiler/aro/backend/Assembly.zig

Code

const std = @import("std");
const Allocator = std.mem.Allocator;

data: []const u8,
text: []const u8,

const Assembly = @This();

pub fn deinit(self: *const Assembly, gpa: Allocator) void {
    gpa.free(self.data);
    gpa.free(self.text);
}

pub fn writeToFile(self: Assembly, io: std.Io, file: std.Io.File) !void {
    var file_writer = file.writer(io, &.{});

    var buffers = [_][]const u8{ self.data, self.text };
    try file_writer.interface.writeSplatAll(&buffers, 1);
}