docs: add docstrings to improve coverage

Jeong-Ryeol · Jeong-Ryeol · commit 4007761ef615 · 2025-12-02T12:05:58.000+09:00
Add documentation comments to public functions and structs
in animation.rs, main.rs, and ui.rs to meet the 80% docstring
coverage threshold.
diff --git a/src/animation.rs b/src/animation.rs
@@ -81,6 +81,7 @@ pub struct EditorBuffer {
 }
 
 impl EditorBuffer {
+    /// Creates a new empty editor buffer with default values.
     pub fn new() -> Self {
         Self {
             lines: vec![String::new()],
@@ -97,6 +98,7 @@ impl EditorBuffer {
         }
     }
 
+    /// Creates an editor buffer initialized with the given content.
     pub fn from_content(content: &str) -> Self {
         let lines: Vec<String> = if content.is_empty() {
             vec![String::new()]
@@ -119,6 +121,7 @@ impl EditorBuffer {
         }
     }
 
+    /// Inserts a character at the specified line and column position.
     pub fn insert_char(&mut self, line: usize, col: usize, ch: char) {
         if line >= self.lines.len() {
             self.lines.resize(line + 1, String::new());
@@ -135,13 +138,15 @@ impl EditorBuffer {
         line_str.insert(byte_idx, ch);
     }
 
+    /// Inserts a new line with the given content at the specified position.
     pub fn insert_line(&mut self, line: usize, content: String) {
         if line > self.lines.len() {
             self.lines.resize(line, String::new());
         }
         self.lines.insert(line, content);
     }
 
+    /// Deletes the line at the specified position.
     pub fn delete_line(&mut self, line: usize) {
         if line < self.lines.len() {
             self.lines.remove(line);
@@ -251,6 +256,7 @@ pub struct AnimationEngine {
 }
 
 impl AnimationEngine {
+    /// Creates a new animation engine with the specified typing speed.
     pub fn new(speed_ms: u64) -> Self {
         let target_fps: u64 = 120;
         let frame_interval_ms = 1000 / target_fps;
@@ -302,10 +308,12 @@ impl AnimationEngine {
         self.base_speed_ms
     }
 
+    /// Sets the viewport height for scroll calculations.
     pub fn set_viewport_height(&mut self, height: usize) {
         self.viewport_height = height;
     }
 
+    /// Sets the content width for line wrapping calculations.
     pub fn set_content_width(&mut self, width: usize) {
         self.content_width = width;
     }
@@ -802,7 +810,7 @@ impl AnimationEngine {
         (cursor_line, buffer_line)
     }
 
-    /// Update animation state and return true if display needs refresh
+    /// Updates animation state and returns true if display needs refresh.
     pub fn tick(&mut self) -> bool {
         self.update_cursor_blink();
 
@@ -1101,6 +1109,7 @@ impl AnimationEngine {
         self.buffer.scroll_offset = logical_offset;
     }
 
+    /// Returns true if the animation has completed.
     pub fn is_finished(&self) -> bool {
         self.state == AnimationState::Finished
     }
diff --git a/src/main.rs b/src/main.rs
@@ -16,6 +16,7 @@ use std::path::{Path, PathBuf};
 use theme::Theme;
 use ui::UI;
 
+/// Defines the order in which commits are played back during animation.
 #[derive(Debug, Clone, Copy, Default, ValueEnum)]
 pub enum PlaybackOrder {
     #[default]
@@ -169,6 +170,7 @@ pub enum ThemeCommands {
 }
 
 impl Args {
+    /// Validates the command-line arguments and returns the Git repository path.
     pub fn validate(&self) -> Result<PathBuf> {
         let start_path = self.path.clone().unwrap_or_else(|| PathBuf::from("."));
 
diff --git a/src/ui.rs b/src/ui.rs
@@ -32,6 +32,7 @@ enum UIState {
     Finished,
 }
 
+/// Main UI controller for the gitlogue terminal interface.
 pub struct UI<'a> {
     state: UIState,
     speed_ms: u64,
@@ -50,6 +51,7 @@ pub struct UI<'a> {
 }
 
 impl<'a> UI<'a> {
+    /// Creates a new UI instance with the specified configuration.
     pub fn new(
         speed_ms: u64,
         repo: Option<&'a GitRepository>,
@@ -101,11 +103,13 @@ impl<'a> UI<'a> {
         .expect("Error setting Ctrl-C handler");
     }
 
+    /// Loads a commit and starts the animation.
     pub fn load_commit(&mut self, metadata: CommitMetadata) {
         self.engine.load_commit(&metadata);
         self.state = UIState::Playing;
     }
 
+    /// Runs the main UI event loop.
     pub fn run(&mut self) -> Result<()> {
         enable_raw_mode()?;
         let mut stdout = io::stdout();

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ pub struct EditorBuffer {`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`impl EditorBuffer {`
	`84`	`+ /// Creates a new empty editor buffer with default values.`
`84`	`85`	`pub fn new() -> Self {`
`85`	`86`	`Self {`
`86`	`87`	`lines: vec![String::new()],`
`@@ -97,6 +98,7 @@ impl EditorBuffer {`
`97`	`98`	`}`
`98`	`99`	`}`
`99`	`100`
	`101`	`+ /// Creates an editor buffer initialized with the given content.`
`100`	`102`	`pub fn from_content(content: &str) -> Self {`
`101`	`103`	`let lines: Vec<String> = if content.is_empty() {`
`102`	`104`	`vec![String::new()]`
`@@ -119,6 +121,7 @@ impl EditorBuffer {`
`119`	`121`	`}`
`120`	`122`	`}`
`121`	`123`
	`124`	`+ /// Inserts a character at the specified line and column position.`
`122`	`125`	`pub fn insert_char(&mut self, line: usize, col: usize, ch: char) {`
`123`	`126`	`if line >= self.lines.len() {`
`124`	`127`	`self.lines.resize(line + 1, String::new());`
`@@ -135,13 +138,15 @@ impl EditorBuffer {`
`135`	`138`	`line_str.insert(byte_idx, ch);`
`136`	`139`	`}`
`137`	`140`
	`141`	`+ /// Inserts a new line with the given content at the specified position.`
`138`	`142`	`pub fn insert_line(&mut self, line: usize, content: String) {`
`139`	`143`	`if line > self.lines.len() {`
`140`	`144`	`self.lines.resize(line, String::new());`
`141`	`145`	`}`
`142`	`146`	`self.lines.insert(line, content);`
`143`	`147`	`}`
`144`	`148`
	`149`	`+ /// Deletes the line at the specified position.`
`145`	`150`	`pub fn delete_line(&mut self, line: usize) {`
`146`	`151`	`if line < self.lines.len() {`
`147`	`152`	`self.lines.remove(line);`
`@@ -251,6 +256,7 @@ pub struct AnimationEngine {`
`251`	`256`	`}`
`252`	`257`
`253`	`258`	`impl AnimationEngine {`
	`259`	`+ /// Creates a new animation engine with the specified typing speed.`
`254`	`260`	`pub fn new(speed_ms: u64) -> Self {`
`255`	`261`	`let target_fps: u64 = 120;`
`256`	`262`	`let frame_interval_ms = 1000 / target_fps;`
`@@ -302,10 +308,12 @@ impl AnimationEngine {`
`302`	`308`	`self.base_speed_ms`
`303`	`309`	`}`
`304`	`310`
	`311`	`+ /// Sets the viewport height for scroll calculations.`
`305`	`312`	`pub fn set_viewport_height(&mut self, height: usize) {`
`306`	`313`	`self.viewport_height = height;`
`307`	`314`	`}`
`308`	`315`
	`316`	`+ /// Sets the content width for line wrapping calculations.`
`309`	`317`	`pub fn set_content_width(&mut self, width: usize) {`
`310`	`318`	`self.content_width = width;`
`311`	`319`	`}`
`@@ -802,7 +810,7 @@ impl AnimationEngine {`
`802`	`810`	`(cursor_line, buffer_line)`
`803`	`811`	`}`
`804`	`812`
`805`		`- /// Update animation state and return true if display needs refresh`
	`813`	`+ /// Updates animation state and returns true if display needs refresh.`
`806`	`814`	`pub fn tick(&mut self) -> bool {`
`807`	`815`	`self.update_cursor_blink();`
`808`	`816`
`@@ -1101,6 +1109,7 @@ impl AnimationEngine {`
`1101`	`1109`	`self.buffer.scroll_offset = logical_offset;`
`1102`	`1110`	`}`
`1103`	`1111`
	`1112`	`+ /// Returns true if the animation has completed.`
`1104`	`1113`	`pub fn is_finished(&self) -> bool {`
`1105`	`1114`	`self.state == AnimationState::Finished`
`1106`	`1115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ enum UIState {`
`32`	`32`	`Finished,`
`33`	`33`	`}`
`34`	`34`
	`35`	`+/// Main UI controller for the gitlogue terminal interface.`
`35`	`36`	`pub struct UI<'a> {`
`36`	`37`	`state: UIState,`
`37`	`38`	`speed_ms: u64,`
`@@ -50,6 +51,7 @@ pub struct UI<'a> {`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`impl<'a> UI<'a> {`
	`54`	`+ /// Creates a new UI instance with the specified configuration.`
`53`	`55`	`pub fn new(`
`54`	`56`	`speed_ms: u64,`
`55`	`57`	`repo: Option<&'a GitRepository>,`
`@@ -101,11 +103,13 @@ impl<'a> UI<'a> {`
`101`	`103`	`.expect("Error setting Ctrl-C handler");`
`102`	`104`	`}`
`103`	`105`
	`106`	`+ /// Loads a commit and starts the animation.`
`104`	`107`	`pub fn load_commit(&mut self, metadata: CommitMetadata) {`
`105`	`108`	`self.engine.load_commit(&metadata);`
`106`	`109`	`self.state = UIState::Playing;`
`107`	`110`	`}`
`108`	`111`
	`112`	`+ /// Runs the main UI event loop.`
`109`	`113`	`pub fn run(&mut self) -> Result<()> {`
`110`	`114`	`enable_raw_mode()?;`
`111`	`115`	`let mut stdout = io::stdout();`