improve some (mostly internal) documentation

Author: Techatrix

src/codegen/codegen.zig

@@ -1,3 +1,5 @@
+//! This program is executed from the build system to generate type bindings for the LSP specification.
+
 const std = @import("std");
 const MetaModel = @import("MetaModel.zig");
 
@@ -1065,11 +1067,17 @@ fn renderMetaModel(gpa: std.mem.Allocator, meta_model: *MetaModel) error{ OutOfM
 
 const Config = struct {
     symbols: []const struct { []const u8, Action },
+    /// List of expressions that should be refactored i.e symbolized into a new
+    /// declaration to avoid generating anonymous types.
+    /// The new name of the declaration will be looked up in `symbols`.
     symbolize: []const []const u8,
 
     const Action = union(enum) {
+        /// Remove the given symbol.
         remove,
+        /// Rename a symbol to the given name.
         rename: []const u8,
+        /// Replace every reference of a symbol with a different one.
         replace_with: []const u8,
     };
 };

src/codegen/config.zon

@@ -92,7 +92,7 @@
         .{"DidCloseNotebookDocumentParams",             .{ .rename = "NotebookDocument.DidCloseParams" } },
         .{"DidOpenNotebookDocumentParams",              .{ .rename = "NotebookDocument.DidOpenParams" } },
         .{"DidSaveNotebookDocumentParams",              .{ .rename = "NotebookDocument.DidSaveParams" } },
-        
+
         .{"NotebookCell",                               .{ .rename = "NotebookCell" } },
         .{"NotebookCellArrayChange",                    .{ .rename = "NotebookCell.ArrayChange" } },
         .{"ExecutionSummary",                           .{ .rename = "NotebookCell.ExecutionSummary" } },

src/codegen/lsp_types_base.zig

@@ -4,14 +4,14 @@
 //! avoid redundancy in names. See the [Zig Style Guide](https://ziglang.org/documentation/master/#Style-Guide)
 //!
 //! Examples:
-//!   - `CompletionItem`              has been renamed to `Completion.Item`
+//!   - `CompletionItem`              has been renamed to `completion.Item`
 //!   - `SemanticTokensRangeParams`   has been renamed to `semantic_tokens.Params.Range`
 //!   - `WorkspaceFoldersChangeEvent` has been renamed to `workspace.folders.ChangeEvent`
 //!   - `CreateFileOptions`           has been renamed to `WorkspaceEdit.CreateFile.Options`
 //!
 //! Contributions that try to improve symbol names are welcome.
 //!
-//! To find the new name for each symbol, use the `@import("lsp").flat`
+//! To find the new name for each symbol, use the `@import("lsp").types.flat`
 //! namespace. This can also be used in place of the "ziggified" symbols if
 //! the original names in the LSP specification are preferred.