What are the best param documentation patterns for Zig?

squeek502 · May 23, 2024, 9:16pm

Note that you can add doc comments to parameters directly.

Example from the standard library:

ziglang/zig/blob/fb88cfdf6aa3fabba700d8340f025e4a3e0d3fb2/lib/std/fs/Dir.zig#L1830-L1843


      
          /// Windows-only. Same as `symLink` except the pathname parameters
          /// are WTF16 LE encoded.
          pub fn symLinkW(
              self: Dir,
              /// WTF-16, does not need to be NT-prefixed. The NT-prefixing
              /// of this path is handled by CreateSymbolicLink.
              /// Any path separators must be `\`, not `/`.
              target_path_w: [:0]const u16,
              /// WTF-16, must be NT-prefixed or relative
              sym_link_path_w: []const u16,
              flags: SymLinkFlags,
          ) !void {
              return windows.CreateSymbolicLink(self.fd, sym_link_path_w, target_path_w, flags.is_directory);
          }

How it looks in autodoc:

https://ziglang.org/documentation/master/std/#std.fs.Dir.symLinkW