@@ -8,10 +8,17 @@ use crate::error::*;
88
99const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs");
1010
11+/// A description for an Input source.
12+/// This tells bat how to refer to the input.
1113#[derive(Debug, Clone)]
1214pub(crate) struct InputDescription {
15+ /// The name of the input used when printing warnings.
1316 pub full: String,
17+
18+ /// The prefix string for the input when displaying it in the header.
1419 pub prefix: String,
20+
21+ /// The name of the input.
1522 pub name: String,
1623}
1724