From b22155d352b2f9499596f50b42b86032bcbf168d Mon Sep 17 00:00:00 2001
From: Bogdan Romanyuk <65823030+wrongnull@users.noreply.github.com>
Date: Sat, 22 Apr 2023 13:55:30 +0300
Subject: Add doc comments for ComptimeStringMap

Some parts of stdlib are still undocumented yet.
---
 lib/std/comptime_string_map.zig | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'lib')

diff --git a/lib/std/comptime_string_map.zig b/lib/std/comptime_string_map.zig
index 267259225c..7620ec7af8 100644
--- a/lib/std/comptime_string_map.zig
+++ b/lib/std/comptime_string_map.zig
@@ -50,12 +50,16 @@ pub fn ComptimeStringMap(comptime V: type, comptime kvs_list: anytype) type {
     };
 
     return struct {
+        /// Array of `struct { key: []const u8, value: V }` where `value` is `void{}` if `V` is `void`.
+        /// Sorted by `key` length.
         pub const kvs = precomputed.sorted_kvs;
 
+        /// Checks if the map has a value for the key.
         pub fn has(str: []const u8) bool {
             return get(str) != null;
         }
 
+        /// Returns the value for the key if any, else null.
         pub fn get(str: []const u8) ?V {
             if (str.len < precomputed.min_len or str.len > precomputed.max_len)
                 return null;
-- 
cgit v1.2.3