mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-08-18 07:11:04 +02:00
Merge pull request #597 from JakeStanger/docs/modules
docs: add rustdoc comments to all module options
This commit is contained in:
commit
63ca68988f
24 changed files with 833 additions and 48 deletions
|
@ -22,20 +22,38 @@ use tracing::{debug, error, trace};
|
|||
pub struct LauncherModule {
|
||||
/// List of app IDs (or classes) to always show regardless of open state,
|
||||
/// in the order specified.
|
||||
///
|
||||
/// **Default**: `null`
|
||||
favorites: Option<Vec<String>>,
|
||||
|
||||
/// Whether to show application names on the bar.
|
||||
///
|
||||
/// **Default**: `false`
|
||||
#[serde(default = "crate::config::default_false")]
|
||||
show_names: bool,
|
||||
|
||||
/// Whether to show application icons on the bar.
|
||||
///
|
||||
/// **Default**: `true`
|
||||
#[serde(default = "crate::config::default_true")]
|
||||
show_icons: bool,
|
||||
|
||||
/// Size in pixels to render icon at (image icons only).
|
||||
///
|
||||
/// **Default**: `32`
|
||||
#[serde(default = "default_icon_size")]
|
||||
icon_size: i32,
|
||||
|
||||
/// Whether items should be added from right-to-left
|
||||
/// instead of left-to-right.
|
||||
///
|
||||
/// This includes favourites.
|
||||
///
|
||||
/// **Default**: `false`
|
||||
#[serde(default = "crate::config::default_false")]
|
||||
reversed: bool,
|
||||
|
||||
/// See [common options](module-level-options#common-options).
|
||||
#[serde(flatten)]
|
||||
pub common: Option<CommonConfig>,
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue