aboutsummaryrefslogtreecommitdiff
path: root/mingling/src/lib.rs
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-05-13 22:28:11 +0800
committer魏曹先生 <1992414357@qq.com>2026-05-13 22:28:11 +0800
commit70c78654c6a6daef5522b9bb01cc7848607a33d4 (patch)
tree3568bda0111f323c54b8280142773d8250bdc83e /mingling/src/lib.rs
parent8b312fc4b4447cfbfde7898ab8f0a1782fcb7aa0 (diff)
Add scripts for building documentation and update docs
Diffstat (limited to 'mingling/src/lib.rs')
-rw-r--r--mingling/src/lib.rs15
1 files changed, 11 insertions, 4 deletions
diff --git a/mingling/src/lib.rs b/mingling/src/lib.rs
index 41a9ec1..2add077 100644
--- a/mingling/src/lib.rs
+++ b/mingling/src/lib.rs
@@ -5,16 +5,15 @@
//!
//! # Use
//!
-//! ```rust,ignore
+//! ```rust
//! use mingling::macros::{dispatcher, gen_program, r_println, renderer};
//!
-//! #[tokio::main]
-//! async fn main() {
+//! fn main() {
//! let mut program = ThisProgram::new();
//! program.with_dispatcher(HelloCommand);
//!
//! // Execute
-//! program.exec().await;
+//! program.exec();
//! }
//!
//! // Define command: "<bin> hello"
@@ -139,6 +138,12 @@ pub mod _mingling_examples {
}
mod features;
+
+/// Module for checking which features are enabled at compile time.
+///
+/// Each constant re-exported from this module corresponds to a Cargo feature flag.
+/// They can be used for conditional compilation or runtime branching based on
+/// feature availability.
pub mod feature {
/// Whether the `async` feature is enabled
pub use crate::features::MINGLING_ASYNC;
@@ -170,8 +175,10 @@ pub mod feature {
mod setups;
+/// Setups provided by Mingling, which can extend command-line programs.
pub mod setup {
pub use crate::setups::*;
}
+/// Mutable global resources provided within Mingling
pub mod res;