Adding some documentation

src/colors.rs

@@ -1,8 +1,25 @@
+//! Colors for use in logging and testing
+
+/// Reset color formatting
 pub const RESET: &str = "\x1b[00m\x1b[0m";
+
+/// Bright red
 pub const RED: &str = "\x1b[31m\x1b[1m";
+
+/// Bright green
 pub const GREEN: &str = "\x1b[32m\x1b[1m";
+
+/// Bright yellow
 pub const YELLOW: &str = "\x1b[33m\x1b[1m";
+
+/// Bright purple
 pub const PURPLE: &str = "\x1b[34m\x1b[1m";
+
+/// Bright pink
 pub const PINK: &str = "\x1b[35m\x1b[1m";
+
+/// Bright cyan
 pub const CYAN: &str = "\x1b[36m\x1b[1m";
+
+/// Bright white
 pub const WHITE: &str = "\x1b[37m\x1b[1m";

src/comments.rs

@@ -1,3 +1,6 @@
+//! Utilities for finding, extracting and removing LaTeX comments
+
+/// Find the location where a comment begins in a line
 pub fn find_comment_index(line: &str) -> Option<usize> {
     // no percent means no comment
     if !line.contains('%') {
@@ -33,10 +36,12 @@ pub fn find_comment_index(line: &str) -> Option<usize> {
     None
 }
 
+/// Remove a comment from the end of a line
 pub fn remove_comment(line: &str, comment: Option<usize>) -> String {
     comment.map_or_else(|| line.to_string(), |c| line.chars().take(c).collect())
 }
 
+/// Extract a comment from the end of a line
 pub fn get_comment(line: &str, comment: Option<usize>) -> String {
     comment.map_or_else(String::new, |c| line.chars().skip(c).collect())
 }

src/format.rs

@@ -1,3 +1,5 @@
+//! Core methodology for formatting a file
+
 use crate::ignore::*;
 use crate::indent::*;
 use crate::leave::*;
@@ -8,6 +10,7 @@ use crate::wrap::*;
 use crate::LINE_END;
 use log::Level::{Info, Warn};
 
+/// Central function to format a file
 pub fn format_file(
     text: &str,
     file: &str,
@@ -64,12 +67,18 @@ pub fn format_file(
     new_text
 }
 
+/// Information on the current state during formatting
 #[derive(Clone, Debug)]
 pub struct State {
+    /// Corresponding line number in the original file
     pub linum_old: usize,
+    /// Corresponding line number in the formatted file
     pub linum_new: usize,
+    /// Ignored status of the current line
     pub ignore: Ignore,
+    /// Indentation status of the current line
     pub indent: Indent,
+    /// Verbatim status of the current line
     pub leave: Leave,
 }
 

src/main.rs

@@ -1,3 +1,6 @@
+//! tex-fmt
+//! An extremely fast LaTeX formatter written in Rust
+
 #![warn(missing_docs)]
 #![warn(clippy::nursery)]
 #![warn(clippy::cargo)]