chore: convert comments to markdown docs

A lot of functions had reasonable description using `//` instead of `///`.  This PR converts them to proper markdown and fixes a few minor styling issues.
This commit is contained in:
Yuri Astrakhan
2025-07-08 23:34:16 -04:00
parent f5a862c55d
commit c433b45682
36 changed files with 151 additions and 150 deletions
+1 -1
View File
@@ -58,7 +58,7 @@ fn generate_split_args() -> String {
args.join(" ")
}
// Function to generate a random string of lines
/// Function to generate a random string of lines
fn generate_random_lines(count: usize) -> String {
let mut rng = rand::rng();
let mut lines = Vec::new();
+1 -1
View File
@@ -49,7 +49,7 @@ fn generate_wc_args() -> String {
args.join(" ")
}
// Function to generate a random string of lines, including invalid ones
/// Function to generate a random string of lines, including invalid ones
fn generate_random_lines(count: usize) -> String {
let mut rng = rand::rng();
let mut lines = Vec::new();