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 standard library. Public Function
Returns error.DirNotEmpty if the directory is not empty.
To delete a directory recursively, see deleteTree.
On Windows, sub_path should be encoded as WTF-8. On WASI, sub_path should be encoded as valid UTF-8. On other platforms, sub_path is an opaque sequence of bytes with no particular encoding.
Returns
error.DirNotEmptyif the directory is not empty.To delete a directory recursively, see
deleteTree.On Windows,
sub_pathshould be encoded as WTF-8. On WASI,sub_pathshould be encoded as valid UTF-8. On other platforms,sub_pathis an opaque sequence of bytes with no particular encoding.