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.
pubfneql(a: Query, b: Query) bool {
if (a.cpu_arch != b.cpu_arch) returnfalse;
if (!a.cpu_model.eql(b.cpu_model)) returnfalse;
if (!a.cpu_features_add.eql(b.cpu_features_add)) returnfalse;
if (!a.cpu_features_sub.eql(b.cpu_features_sub)) returnfalse;
if (a.os_tag != b.os_tag) returnfalse;
if (!OsVersion.eqlOpt(a.os_version_min, b.os_version_min)) returnfalse;
if (!OsVersion.eqlOpt(a.os_version_max, b.os_version_max)) returnfalse;
if (!versionEqualOpt(a.glibc_version, b.glibc_version)) returnfalse;
if (a.android_api_level != b.android_api_level) returnfalse;
if (a.abi != b.abi) returnfalse;
if (!dynamicLinkerEqualOpt(a.dynamic_linker, b.dynamic_linker)) returnfalse;
if (a.ofmt != b.ofmt) returnfalse;
returntrue;
}