Documentation on API functions

This commit is contained in:
Robin Voetter
2020-07-07 01:52:37 +02:00
parent 89c511653e
commit b25521b22f
3 changed files with 38 additions and 1 deletions

View File

@@ -326,6 +326,10 @@ pub const Generator = struct {
}
};
/// Main function for generating the Vulkan bindings. vk.xml is to be provided via `spec_xml`,
/// and the resulting binding is written to `writer`. `allocator` will be used to allocate temporary
/// internal datastructures - mostly via an ArenaAllocator, but sometimes a hashmap uses this allocator
/// directly.
pub fn generate(allocator: *Allocator, spec_xml: []const u8, writer: var) !void {
const spec = try xml.parse(allocator, spec_xml);
defer spec.deinit();