src/ update docstrings printer/ filedecompressor.rs

src/printer/mod.rs

@@ -5,6 +5,9 @@
 //! with various text effects (color, underline, etc.)
 //! and per-line prepended data (datetime, file name, etc.).
 //!
+//! [`summary`] module is functions to handle the user passed `--summary`
+//! option.
+//!
 //! [`Sysline`s]: crate::data::sysline::Sysline
 //! [`FixedStruct`s]: crate::data::fixedstruct::FixedStruct
 //! [`Evtx`s]: crate::data::evtx::Evtx

src/printer/summary.rs

@@ -1,10 +1,9 @@
-// summary.rs
+// src/printer/summary.rs
 
-#![allow(non_camel_case_types)]
+//! CLI option `--summary` printing functions.
+//! Only used by `s4.rs`.
 
-/// CLI option `--summary` printing functions
-///
-/// Only used by `s4.rs`
+#![allow(non_camel_case_types)]
 
 use std::collections::{BTreeMap, HashMap};
 use std::fmt;

src/readers/filedecompressor.rs

@@ -1,4 +1,6 @@
-// filedecompressor.rs
+// src/readers/filedecompressor.rs
+
+//! The `filedecompressor` module is for decompressing files to temporary files.
 
 use std::borrow::Cow;
 use std::io::{BufReader, BufWriter, Error, ErrorKind, Read, Result, Write};