Add module documentation headers

src/config.rs

@@ -1,3 +1,5 @@
+//! Handles configuration loading and saving
+
 use std::fs;
 use std::io::{Read, Write};
 use std::path::PathBuf;

src/field.rs

@@ -1,3 +1,5 @@
+//! Defines the various fields available in the query language
+
 use std::fmt::Display;
 use std::fmt::Error;
 use std::fmt::Formatter;

src/function.rs

@@ -1,3 +1,6 @@
+//! Functions for processing values in the query language.
+//! This module contains both the regular and aggregate functions used in the query language.
+
 use std::collections::HashMap;
 use std::fmt::Display;
 use std::fmt::Error;

src/ignore/docker.rs

@@ -1,3 +1,5 @@
+//! Handles .dockerignore parsing
+
 use std::fs::File;
 use std::io::BufRead;
 use std::io::BufReader;

src/ignore/git.rs

@@ -1,3 +1,5 @@
+//! Handles .gitignore parsing
+
 use std::collections::HashMap;
 use std::fs::File;
 use std::ops::Add;

src/ignore/hg.rs

@@ -1,3 +1,5 @@
+//! Handles .hgignore parsing (Mercurial)
+
 use std::fs::File;
 use std::io::BufRead;
 use std::io::BufReader;

src/lexer.rs

@@ -1,3 +1,5 @@
+//! Lexer to tokenizes SQL-like syntax into lexems
+
 use std::str::FromStr;
 
 use regex::Regex;

src/main.rs

@@ -1,3 +1,6 @@
+//! The entry point of the program
+//! Handles the command line arguments parsing
+
 #[macro_use]
 extern crate lazy_static;
 #[macro_use]

src/mode.rs

@@ -1,3 +1,5 @@
+//! This module contains functions for working with file modes / permissions
+
 use std::fs::Metadata;
 #[cfg(unix)]
 use std::os::unix::fs::MetadataExt;

src/operators.rs

@@ -1,3 +1,5 @@
+//! Defines the arithmetic operators used in the query language
+
 use crate::function::Variant;
 
 #[derive(Debug, Clone, Eq, Hash, PartialEq, PartialOrd, Serialize)]

src/output/csv.rs

@@ -1,3 +1,5 @@
+//! Handles export of results in CSV format
+
 use crate::output::ResultsFormatter;
 use crate::util::WritableBuffer;
 

src/output/flat.rs

@@ -1,3 +1,5 @@
+//! Handles export of results in line-separated, list-separated, and tab-separated formats
+
 use crate::output::ResultsFormatter;
 
 pub const LINES_FORMATTER: FlatWriter = FlatWriter {

src/output/html.rs

@@ -1,3 +1,5 @@
+//! Handles export of results in HTML format
+
 use crate::output::ResultsFormatter;
 
 pub struct HtmlFormatter;

src/output/json.rs

@@ -1,3 +1,5 @@
+//! Handles export of results in JSON format
+
 use crate::output::ResultsFormatter;
 use std::collections::BTreeMap;
 

src/parser.rs

@@ -1,3 +1,5 @@
+//! Handles the parsing of the query string
+
 use std::rc::Rc;
 use std::str::FromStr;
 

src/query.rs

@@ -1,3 +1,6 @@
+//! Defines the query struct and related types.
+//! Query parsing is handled in the `parser` module
+
 use std::collections::HashSet;
 use std::rc::Rc;
 

src/searcher.rs

@@ -1,3 +1,5 @@
+//! Handles directory traversal and file processing.
+
 use std::collections::{HashMap, HashSet, VecDeque};
 use std::fs;
 #[cfg(unix)]