From 29121d32fad7760071644fe84e7c3251a19c7cde Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Sat, 16 May 2026 16:36:54 +0800
Subject: Add doc comment for ExitCode struct usage

---
 mingling/src/res/exit_code.rs | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'mingling/src/res')

diff --git a/mingling/src/res/exit_code.rs b/mingling/src/res/exit_code.rs
index f4d4238..b483139 100644
--- a/mingling/src/res/exit_code.rs
+++ b/mingling/src/res/exit_code.rs
@@ -1,6 +1,13 @@
 use mingling_core::{ProgramCollect, this};
 
 /// Represents a program exit code.
+///
+/// This struct should be used together with `ExitCodeSetup`:
+/// ```ignore
+/// program.with_setup(ExitCodeSetup::default());
+/// ```
+/// The exit code is stored globally per `ProgramCollect` type and can be
+/// retrieved via [`exit_code()`] or updated via [`update_exit_code()`].
 #[derive(Debug, Default, Clone, Copy)]
 pub struct ExitCode {
     /// The numeric exit code value.
-- 
cgit