Added comments to fields of DownlinkConfig.

Author: horned-sphere

api/swimos_api/src/downlink/mod.rs

@@ -25,8 +25,12 @@ use swimos_utilities::{
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 /// General downlink configuration parameters.
 pub struct DownlinkConfig {
+    /// If this is set, lifecycle events will be called for events before the downlink is synchronized with the remote lane.
+    /// (default: false).
     pub events_when_not_synced: bool,
+    /// If this is set, the downlink will stop if it enters the unlinked state (default: true).
     pub terminate_on_unlinked: bool,
+    /// The size of the channel to send commands to the downlinks.
     pub buffer_size: NonZeroUsize,
 }