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.

printAnotherMessage

This is a documentation comment to explain the printAnotherMessage function below.

Accepting an Io.Writer instance is a handy way to write reusable code.

root.printAnotherMessage

pub fn printAnotherMessage(writer: *Io.Writer) Io.Writer.Error!void

File

lib/init/src/root.zig:8

Code

pub fn printAnotherMessage(writer: *Io.Writer) Io.Writer.Error!void {
    try writer.print("Run `zig build test` to run the tests.\n", .{});
}