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.
constBASE_STATIC_SERVER_DATA = externstruct {
windows_directory: ForeignString,
windows_system_directory: ForeignString,
named_object_directory: ForeignString,
/// This matches the 64-bit version of `UNICODE_STRING`---even on 32-bit targets, this string is/// from 64-bit code (since it comes from CSRSS which is running outside of WOW64).constForeignString = externstruct {
length: u16,
maximum_length: u16,
/// Address in the CSRSS address space. To convert this to a valid pointer in *our* address/// space, see `relocateCsrssAddress` (or the `ForeignString.relocate` wrapper function).buffer_address: u64,
fnrelocate(str: ForeignString) UNICODE_STRING {
return .{
.Length = str.length,
.MaximumLength = str.maximum_length,
.Buffer = @ptrCast(@alignCast(@constCast(relocateCsrssAddress(str.buffer_address)))),
};
}
};
}