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/error.rs | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

(limited to 'mingling_pathf/src/error.rs')

diff --git a/mingling_pathf/src/error.rs b/mingling_pathf/src/error.rs
index 70a8f6e..d384901 100644
--- a/mingling_pathf/src/error.rs
+++ b/mingling_pathf/src/error.rs
@@ -22,7 +22,9 @@ pub enum MinglingPathfinderError {
     /// `parent` is the directory containing the file that declared the module.
     /// `module_name` is the name of the module that could not be found.
     ModuleNotFound {
+        /// The directory containing the file that declared the module.
         parent: PathBuf,
+        /// The name of the module that could not be found.
         module_name: String,
     },
 
@@ -30,7 +32,12 @@ pub enum MinglingPathfinderError {
     ///
     /// `file` is the file containing the invalid attribute.
     /// `path_attr` is the value of the `#[path]` attribute.
-    PathPointsOutside { file: PathBuf, path_attr: String },
+    PathPointsOutside {
+        /// The file containing the invalid `#[path]` attribute.
+        file: PathBuf,
+        /// The value of the `#[path]` attribute that points outside the project.
+        path_attr: String,
+    },
 
     /// No entry point file (`main.rs`, `lib.rs`, or any file under `bin/`) was found.
     NoEntryPointFound,
@@ -39,7 +46,12 @@ pub enum MinglingPathfinderError {
     ///
     /// `path` is the file that failed to parse.
     /// `message` contains details from the parser.
-    SynError { path: PathBuf, message: String },
+    SynError {
+        /// The file that failed to parse.
+        path: PathBuf,
+        /// Details from the parser about the parse failure.
+        message: String,
+    },
 }
 
 impl fmt::Display for MinglingPathfinderError {
-- 
cgit