mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-08-18 07:11:04 +02:00
docs: add rustdoc comments to all module options
This part of an upcoming effort to generate documentation from code. Pushing this out before that stage so that the JSON schema is fully documented.
This commit is contained in:
parent
3b6480f3f2
commit
c7743b28c6
24 changed files with 833 additions and 48 deletions
|
@ -12,14 +12,29 @@ use tracing::error;
|
|||
#[derive(Debug, Deserialize, Clone)]
|
||||
pub struct ScriptModule {
|
||||
/// Path to script to execute.
|
||||
///
|
||||
/// This can be an absolute path,
|
||||
/// or relative to the working directory.
|
||||
///
|
||||
/// **Required**
|
||||
cmd: String,
|
||||
/// Script execution mode
|
||||
|
||||
/// Script execution mode.
|
||||
/// See [modes](#modes) for more info.
|
||||
///
|
||||
/// **Valid options**: `poll`, `watch`
|
||||
/// <br />
|
||||
/// **Default**: `poll`
|
||||
#[serde(default = "default_mode")]
|
||||
mode: ScriptMode,
|
||||
|
||||
/// Time in milliseconds between executions.
|
||||
///
|
||||
/// **Default**: `5000`
|
||||
#[serde(default = "default_interval")]
|
||||
interval: u64,
|
||||
|
||||
/// 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