From f1ed18e668a830646fe507ee33c4b010a1690342 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Wed, 1 Apr 2026 20:14:56 +0800
Subject: Add documentation for mingling_core

---
 mingling_core/src/renderer/render_result.rs | 41 +++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'mingling_core/src/renderer')

diff --git a/mingling_core/src/renderer/render_result.rs b/mingling_core/src/renderer/render_result.rs
index 73c38e7..d9da7b7 100644
--- a/mingling_core/src/renderer/render_result.rs
+++ b/mingling_core/src/renderer/render_result.rs
@@ -3,6 +3,7 @@ use std::{
     ops::Deref,
 };
 
+/// Render result, containing the rendered text content.
 #[derive(Default, Debug, PartialEq)]
 pub struct RenderResult {
     render_text: String,
@@ -23,15 +24,55 @@ impl Deref for RenderResult {
 }
 
 impl RenderResult {
+    /// Appends the given text to the rendered content.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use mingling_core::RenderResult;
+    /// use std::ops::Deref;
+    ///
+    /// let mut result = RenderResult::default();
+    /// result.print("Hello");
+    /// result.print(", world!");
+    /// assert_eq!(result.deref(), "Hello, world!");
+    /// ```
     pub fn print(&mut self, text: &str) {
         self.render_text.push_str(text);
     }
 
+    /// Appends the given text followed by a newline to the rendered content.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use mingling_core::RenderResult;
+    /// use std::ops::Deref;
+    ///
+    /// let mut result = RenderResult::default();
+    /// result.println("First line");
+    /// result.println("Second line");
+    /// assert_eq!(result.deref(), "First line\nSecond line\n");
+    /// ```
     pub fn println(&mut self, text: &str) {
         self.render_text.push_str(text);
         self.render_text.push('\n');
     }
 
+    /// Clears all rendered content.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use mingling_core::RenderResult;
+    /// use std::ops::Deref;
+    ///
+    /// let mut result = RenderResult::default();
+    /// result.print("Some content");
+    /// assert!(!result.is_empty());
+    /// result.clear();
+    /// assert!(result.is_empty());
+    /// ```
     pub fn clear(&mut self) {
         self.render_text.clear();
     }
-- 
cgit