From 9f5a0f2e9325264564bc6fe9ff544c034ad16287 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Mon, 20 Jul 2026 14:49:47 +0800
Subject: chore: add missing docs lint and document public API

Add `#![deny(missing_docs)]` across multiple crates and fill in
documentation for all public items, including struct fields, enum
variants, trait methods, and proc macros.  Also mark two shell scripts
as executable.
---
 mingling_pathf/src/patterns/dispatcher.rs      | 8 ++++++++
 mingling_pathf/src/patterns/dispatcher_clap.rs | 6 ++++++
 2 files changed, 14 insertions(+)

(limited to 'mingling_pathf/src/patterns')

diff --git a/mingling_pathf/src/patterns/dispatcher.rs b/mingling_pathf/src/patterns/dispatcher.rs
index 6796a2c..eaa53f0 100644
--- a/mingling_pathf/src/patterns/dispatcher.rs
+++ b/mingling_pathf/src/patterns/dispatcher.rs
@@ -20,10 +20,18 @@ use crate::pattern_analyzer::{AnalyzeItem, AnalyzePattern};
 /// - `CMD*` — the dispatcher struct (always)
 /// - `__internal_dispatcher_*` — dispatch tree static (when `use_dispatch_tree` is true)
 pub struct DispatcherPattern {
+    /// Whether the dispatcher generates a dispatch tree static (`__internal_dispatcher_*`).
     pub use_dispatch_tree: bool,
 }
 
 impl DispatcherPattern {
+    /// Creates a new `DispatcherPattern`.
+    ///
+    /// # Arguments
+    ///
+    /// * `use_dispatch_tree` — when `true`, the generated dispatcher also produces a
+    ///   `__internal_dispatcher_*` static dispatch tree item. Set this based on whether
+    ///   your macro invocation includes the `use_dispatch_tree` configuration.
     pub fn new(use_dispatch_tree: bool) -> Self {
         Self { use_dispatch_tree }
     }
diff --git a/mingling_pathf/src/patterns/dispatcher_clap.rs b/mingling_pathf/src/patterns/dispatcher_clap.rs
index 1a86ad5..0a249b4 100644
--- a/mingling_pathf/src/patterns/dispatcher_clap.rs
+++ b/mingling_pathf/src/patterns/dispatcher_clap.rs
@@ -29,10 +29,16 @@ use crate::pattern_analyzer::{AnalyzeItem, AnalyzePattern};
 /// - `#[dispatcher_clap("greet", CMDGreet, help = true)] struct EntryGreet { ... }`
 /// - `#[dispatcher_clap("greet", CMDGreet, error = ErrorGreet, help = true)] struct EntryGreet { ... }`
 pub struct DispatcherClapPattern {
+    /// Whether to include the `__internal_dispatcher_*` dispatch tree static in the analysis.
     pub use_dispatch_tree: bool,
 }
 
 impl DispatcherClapPattern {
+    /// Creates a new `DispatcherClapPattern` with the given configuration.
+    ///
+    /// # Parameters
+    /// - `use_dispatch_tree`: When `true`, enables analysis of the `__internal_dispatcher_*`
+    ///   static dispatch tree for each matched command.
     pub fn new(use_dispatch_tree: bool) -> Self {
         Self { use_dispatch_tree }
     }
-- 
cgit