docs: add core module and API documentation

src/config/bookmarks/aws_s3.rs

@@ -1,3 +1,7 @@
+//! ## Bookmark S3 Parameters
+//!
+//! Stores the bookmark-specific representation of AWS S3 connection settings.
+
 use serde::{Deserialize, Serialize};
 
 use crate::filetransfer::params::AwsS3Params;
@@ -5,13 +9,20 @@ use crate::filetransfer::params::AwsS3Params;
 /// Connection parameters for Aws s3 protocol
 #[derive(Clone, Deserialize, Serialize, Debug, PartialEq, Eq, Default)]
 pub struct S3Params {
+    /// Bucket name to open.
     pub bucket: String,
+    /// AWS region used for the bucket.
     pub region: Option<String>,
+    /// Custom endpoint URL for S3-compatible services.
     pub endpoint: Option<String>,
+    /// Shared credentials profile name.
     pub profile: Option<String>,
+    /// Static access key identifier.
     pub access_key: Option<String>,
+    /// Static secret access key.
     pub secret_access_key: Option<String>,
     /// NOTE: there are no session token and security token since they are always temporary
+    /// Whether to force path-style bucket addressing.
     pub new_path_style: Option<bool>,
 }
 

src/config/bookmarks/kube.rs

@@ -1,3 +1,7 @@
+//! ## Bookmark Kube Parameters
+//!
+//! Stores bookmark-specific Kubernetes connection settings.
+
 use serde::{Deserialize, Serialize};
 
 use crate::filetransfer::params::KubeProtocolParams;
@@ -5,10 +9,15 @@ use crate::filetransfer::params::KubeProtocolParams;
 /// Extra Connection parameters for Kube protocol
 #[derive(Clone, Deserialize, Serialize, Debug, PartialEq, Eq, Default)]
 pub struct KubeParams {
+    /// Optional default namespace.
     pub namespace: Option<String>,
+    /// Optional cluster API URL.
     pub cluster_url: Option<String>,
+    /// Optional Kubernetes username override.
     pub username: Option<String>,
+    /// Optional client certificate path.
     pub client_cert: Option<String>,
+    /// Optional client key path.
     pub client_key: Option<String>,
 }
 

src/config/bookmarks/smb.rs

@@ -1,3 +1,7 @@
+//! ## Bookmark SMB Parameters
+//!
+//! Stores bookmark-specific SMB share configuration.
+
 use serde::{Deserialize, Serialize};
 
 use crate::filetransfer::params::SmbParams as TransferSmbParams;
@@ -5,7 +9,9 @@ use crate::filetransfer::params::SmbParams as TransferSmbParams;
 /// Extra Connection parameters for SMB protocol
 #[derive(Clone, Deserialize, Serialize, Debug, PartialEq, Eq, Default)]
 pub struct SmbParams {
+    /// SMB share name.
     pub share: String,
+    /// Optional SMB workgroup used on POSIX platforms.
     pub workgroup: Option<String>,
 }