1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-07-04 20:21:02 +02:00

docs: add some rustdoc comments throughout

This commit is contained in:
Jake Stanger 2022-08-28 16:57:41 +01:00
parent 5d319e91f2
commit 78e30b39fe
16 changed files with 84 additions and 2 deletions

View file

@ -23,15 +23,20 @@ use tracing::error;
#[derive(Debug, Deserialize, Clone)]
pub struct MpdModule {
/// TCP or Unix socket address.
#[serde(default = "default_socket")]
host: String,
/// Format of current song info to display on the bar.
#[serde(default = "default_format")]
format: String,
/// Icon to display when playing.
#[serde(default = "default_icon_play")]
icon_play: Option<String>,
/// Icon to display when paused.
#[serde(default = "default_icon_pause")]
icon_pause: Option<String>,
/// Path to root of music directory.
#[serde(default = "default_music_dir")]
music_dir: PathBuf,
}