aboutsummaryrefslogtreecommitdiff
path: root/mingling_pathf
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-08-14 00:23:06 +0800
committer魏曹先生 <1992414357@qq.com>2026-08-14 00:23:06 +0800
commit1198f2b81a845bd475594cdf42d04e7bd750ebd2 (patch)
treecdeaa872cd704dd579771c5e63c8e0026be1d5e8 /mingling_pathf
parent1f2462ae53446c37c6cfe53a57ea86f695c4ef0a (diff)
chore: add "Doc Not Optimize" comments to source files
Mark all source files with a comment indicating they are not optimized for documentation purposes.
Diffstat (limited to 'mingling_pathf')
-rw-r--r--mingling_pathf/src/config.rs1
-rw-r--r--mingling_pathf/src/error.rs1
-rw-r--r--mingling_pathf/src/lib.rs1
-rw-r--r--mingling_pathf/src/module_pathf.rs1
-rw-r--r--mingling_pathf/src/pattern_analyzer.rs1
-rw-r--r--mingling_pathf/src/patterns.rs1
-rw-r--r--mingling_pathf/src/patterns/basic_struct.rs1
-rw-r--r--mingling_pathf/src/patterns/chain.rs1
-rw-r--r--mingling_pathf/src/patterns/command.rs1
-rw-r--r--mingling_pathf/src/patterns/completion.rs1
-rw-r--r--mingling_pathf/src/patterns/dispatcher.rs1
-rw-r--r--mingling_pathf/src/patterns/dispatcher_clap.rs1
-rw-r--r--mingling_pathf/src/patterns/group.rs1
-rw-r--r--mingling_pathf/src/patterns/grouped_derive.rs1
-rw-r--r--mingling_pathf/src/patterns/help.rs1
-rw-r--r--mingling_pathf/src/patterns/metadata.rs1
-rw-r--r--mingling_pathf/src/patterns/pack.rs1
-rw-r--r--mingling_pathf/src/patterns/renderer.rs1
-rw-r--r--mingling_pathf/src/type_mapping_builder.rs1
19 files changed, 19 insertions, 0 deletions
diff --git a/mingling_pathf/src/config.rs b/mingling_pathf/src/config.rs
index 758aa34..10ef002 100644
--- a/mingling_pathf/src/config.rs
+++ b/mingling_pathf/src/config.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! Configuration for the module pathfinder analysis.
//!
//! This module defines [`PathfinderConfig`], which controls behavior such as
diff --git a/mingling_pathf/src/error.rs b/mingling_pathf/src/error.rs
index d384901..5a748c4 100644
--- a/mingling_pathf/src/error.rs
+++ b/mingling_pathf/src/error.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! Errors that can occur during the pathfinding process for Rust module resolution.
//!
//! This module defines all possible failure modes when traversing the module graph
diff --git a/mingling_pathf/src/lib.rs b/mingling_pathf/src/lib.rs
index d54cf58..93a80a3 100644
--- a/mingling_pathf/src/lib.rs
+++ b/mingling_pathf/src/lib.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
#![allow(clippy::needless_doctest_main)]
#![doc = include_str!("../README.md")]
#![deny(missing_docs)]
diff --git a/mingling_pathf/src/module_pathf.rs b/mingling_pathf/src/module_pathf.rs
index ebb7979..cc2df91 100644
--- a/mingling_pathf/src/module_pathf.rs
+++ b/mingling_pathf/src/module_pathf.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! A module for mapping Rust module paths to source files.
//!
//! This module provides functionality to analyze the module structure of a Rust crate
diff --git a/mingling_pathf/src/pattern_analyzer.rs b/mingling_pathf/src/pattern_analyzer.rs
index 44df7ad..c2dd25f 100644
--- a/mingling_pathf/src/pattern_analyzer.rs
+++ b/mingling_pathf/src/pattern_analyzer.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! This module defines the core pattern analysis system used to parse and extract
//! importable/referenceable items (like structs, enums, functions, etc.) from Rust source files.
//!
diff --git a/mingling_pathf/src/patterns.rs b/mingling_pathf/src/patterns.rs
index 29d757b..fa0fc8b 100644
--- a/mingling_pathf/src/patterns.rs
+++ b/mingling_pathf/src/patterns.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! Mingling path matching patterns for command routing and field mapping.
pub use chain::*;
diff --git a/mingling_pathf/src/patterns/basic_struct.rs b/mingling_pathf/src/patterns/basic_struct.rs
index 9218d65..256426c 100644
--- a/mingling_pathf/src/patterns/basic_struct.rs
+++ b/mingling_pathf/src/patterns/basic_struct.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `BasicStructPattern` matches `struct` definitions in Rust source code.
//! It identifies root-level structs and structs nested inside inline modules,
//! returning their names and optional module path for analysis.
diff --git a/mingling_pathf/src/patterns/chain.rs b/mingling_pathf/src/patterns/chain.rs
index 2e95db2..73192cd 100644
--- a/mingling_pathf/src/patterns/chain.rs
+++ b/mingling_pathf/src/patterns/chain.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `ChainPattern` matches functions annotated with `#[chain]` and
//! extracts the generated internal struct name (e.g., `__internal_chain_<fn_name>`).
//! This is used to track chained handler functions for code generation or analysis.
diff --git a/mingling_pathf/src/patterns/command.rs b/mingling_pathf/src/patterns/command.rs
index fac70af..c30e130 100644
--- a/mingling_pathf/src/patterns/command.rs
+++ b/mingling_pathf/src/patterns/command.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `CommandPattern` matches functions annotated with `#[command]` and
//! extracts the generated hidden module name (`__command_<fn>_module`).
//!
diff --git a/mingling_pathf/src/patterns/completion.rs b/mingling_pathf/src/patterns/completion.rs
index cff62e0..e1fe9b5 100644
--- a/mingling_pathf/src/patterns/completion.rs
+++ b/mingling_pathf/src/patterns/completion.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `CompletionPattern` matches functions annotated with `#[completion(T)]` and
//! extracts the generated internal struct name (e.g., `__internal_completion_<fn_name>`).
//! This is used to track completion handler functions for code generation or analysis.
diff --git a/mingling_pathf/src/patterns/dispatcher.rs b/mingling_pathf/src/patterns/dispatcher.rs
index 85220b5..56d2b97 100644
--- a/mingling_pathf/src/patterns/dispatcher.rs
+++ b/mingling_pathf/src/patterns/dispatcher.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `DispatcherPattern` matches invocations of the `dispatcher!` macro and
//! extracts the generated type names from its arguments. It supports:
//! - `Entry*` — the entry type (always generated)
diff --git a/mingling_pathf/src/patterns/dispatcher_clap.rs b/mingling_pathf/src/patterns/dispatcher_clap.rs
index ca2ce9e..55001a6 100644
--- a/mingling_pathf/src/patterns/dispatcher_clap.rs
+++ b/mingling_pathf/src/patterns/dispatcher_clap.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `DispatcherClapPattern` matches structs annotated with `#[dispatcher_clap(...)]` and
//! extracts key items for code generation or analysis:
//! - The entry struct name (always)
diff --git a/mingling_pathf/src/patterns/group.rs b/mingling_pathf/src/patterns/group.rs
index 905afa9..7aa4c17 100644
--- a/mingling_pathf/src/patterns/group.rs
+++ b/mingling_pathf/src/patterns/group.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `GroupPattern` matches the `group!` and `group_structural!` macros and
//! extracts the type name or alias defined within them.
//! This is used to track type groups for code generation or analysis.
diff --git a/mingling_pathf/src/patterns/grouped_derive.rs b/mingling_pathf/src/patterns/grouped_derive.rs
index 56a87f9..b2eae97 100644
--- a/mingling_pathf/src/patterns/grouped_derive.rs
+++ b/mingling_pathf/src/patterns/grouped_derive.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `GroupedDerivePattern` matches structs, enums, and unions annotated with
//! `#[derive(Grouped)]` or `#[derive(GroupedSerialize)]` (or any combination
//! with other derives). It also recurses into `mod` items to find nested types.
diff --git a/mingling_pathf/src/patterns/help.rs b/mingling_pathf/src/patterns/help.rs
index 85793c3..b75c771 100644
--- a/mingling_pathf/src/patterns/help.rs
+++ b/mingling_pathf/src/patterns/help.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `HelpPattern` matches functions annotated with `#[help]` and
//! extracts the generated internal struct name (e.g., `__internal_help_<fn_name>`).
//! This is used to track help functions for code generation or analysis.
diff --git a/mingling_pathf/src/patterns/metadata.rs b/mingling_pathf/src/patterns/metadata.rs
index 32a283a..21be2e6 100644
--- a/mingling_pathf/src/patterns/metadata.rs
+++ b/mingling_pathf/src/patterns/metadata.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `MetadataPattern` matches functions annotated with `#[metadata(BindType)]`
//! and extracts two types referenced by the metadata system:
//! - `BindType` — the entry enum variant the metadata is bound to (attribute argument)
diff --git a/mingling_pathf/src/patterns/pack.rs b/mingling_pathf/src/patterns/pack.rs
index e5e14e6..10327a7 100644
--- a/mingling_pathf/src/patterns/pack.rs
+++ b/mingling_pathf/src/patterns/pack.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `PackPattern` matches types defined by `pack!`, `pack_err!`, `pack_structural!`, and `pack_err_structural!` macros.
//! It extracts the registered type name (e.g., `TypeName` from `pack!(TypeName = InnerType)`).
//! This is used to track packed type definitions for code generation or analysis.
diff --git a/mingling_pathf/src/patterns/renderer.rs b/mingling_pathf/src/patterns/renderer.rs
index 153e603..edcd8a7 100644
--- a/mingling_pathf/src/patterns/renderer.rs
+++ b/mingling_pathf/src/patterns/renderer.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! The `RendererPattern` matches functions annotated with `#[renderer]` and
//! extracts the generated internal struct name (e.g., `__internal_renderer_<fn_name>`).
//! This is used to track rendering functions for code generation or analysis.
diff --git a/mingling_pathf/src/type_mapping_builder.rs b/mingling_pathf/src/type_mapping_builder.rs
index 9f8980d..5341578 100644
--- a/mingling_pathf/src/type_mapping_builder.rs
+++ b/mingling_pathf/src/type_mapping_builder.rs
@@ -1,3 +1,4 @@
+// Doc Not Optimize
//! This module contains the matching patterns for `mingling_pathf`.
//! It provides the core logic for analyzing crate types and generating
//! type mapping files used by the pathfinder system.