diff options
author | Matthias Beyer <matthias.beyer@ifm.com> | 2022-07-02 15:58:18 +0200 |
---|---|---|
committer | Matthias Beyer <matthias.beyer@ifm.com> | 2022-07-02 15:58:18 +0200 |
commit | 1561eca86e1068de772f9d21106e9c727726bd7e (patch) | |
tree | d7da688e1b0f621318e08d96d71af4ee0c503fa4 | |
parent | 0a44be086085d0b6d2a90a43e2a6db5e651ebd3f (diff) |
Expand the documentation for AsConfigfeature/add_tedge_api_only/config-doc
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
-rw-r--r-- | crates/core/tedge_api/src/config.rs | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/crates/core/tedge_api/src/config.rs b/crates/core/tedge_api/src/config.rs index 0ec9c134..95be12b0 100644 --- a/crates/core/tedge_api/src/config.rs +++ b/crates/core/tedge_api/src/config.rs @@ -126,9 +126,13 @@ pub enum ConfigKind { ), } -/// Turn a plugin configuration into a [`ConfigDescription`] object +/// Turn a plugin configuration type into a [`ConfigDescription`] object +/// +/// Plugin authors are expected to implement (or derive) this for their configurations to give +/// users. +/// +/// Implementations for all base types (Bool, Numbers, String, List, Key-Value maps) exist. /// -/// Plugin authors are expected to implement this for their configurations to give users pub trait AsConfig { /// Get a [`ConfigDescription`] object from the type fn as_config() -> ConfigDescription; |