1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-03-22 23:05:22 +02:00

Add Rustdoc comments for functions.

This commit is contained in:
Andrew Walbran 2023-03-30 15:03:35 +01:00
parent 9372d14378
commit adabd342ff

View File

@ -92,6 +92,8 @@ fn main() -> anyhow::Result<()> {
Ok(())
}
/// Writes the given output file based on the given code text from the Markdown input, processing
/// include directives as necessary.
fn write_output(
text: CowStr,
input_directory: &Path,
@ -123,6 +125,8 @@ fn write_output(
Ok(())
}
/// Writes the given `section` (or all, if it is `None`) of the given included file (relative to the
/// `input_directory`) to the `output_file`.
fn write_include(
include_filename: &str,
section: Option<&str>,