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