summaryrefslogtreecommitdiff
path: root/crates
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2025-09-26 14:30:57 +0800
committer魏曹先生 <1992414357@qq.com>2025-09-26 14:30:57 +0800
commitbb4a3f46d9d217fd71ee8a0ebdd78cc2c427fa9f (patch)
tree041f50027dd44dc80bec4403fbccc501dd5dd61d /crates
parent81c9f47f5d9517ab273a34aeea4b6e40f45aac36 (diff)
docs: Add module-level documentation comments
- Add documentation comments to VaultConfig, Sheets, and VirtualFile modules - Improve code documentation for better maintainability
Diffstat (limited to 'crates')
-rw-r--r--crates/vcs/src/data/vault/config.rs1
-rw-r--r--crates/vcs/src/data/vault/sheets.rs1
-rw-r--r--crates/vcs/src/data/vault/virtual_file.rs1
3 files changed, 3 insertions, 0 deletions
diff --git a/crates/vcs/src/data/vault/config.rs b/crates/vcs/src/data/vault/config.rs
index e879325..40ba09f 100644
--- a/crates/vcs/src/data/vault/config.rs
+++ b/crates/vcs/src/data/vault/config.rs
@@ -23,6 +23,7 @@ impl Default for VaultConfig {
}
}
+/// Vault Management
impl VaultConfig {
// Change name of the vault.
pub fn change_name(&mut self, name: impl Into<String>) {
diff --git a/crates/vcs/src/data/vault/sheets.rs b/crates/vcs/src/data/vault/sheets.rs
index bcd5779..082c076 100644
--- a/crates/vcs/src/data/vault/sheets.rs
+++ b/crates/vcs/src/data/vault/sheets.rs
@@ -13,6 +13,7 @@ use crate::{
},
};
+/// Vault Sheets Management
impl Vault {
/// Load all sheets in the vault
///
diff --git a/crates/vcs/src/data/vault/virtual_file.rs b/crates/vcs/src/data/vault/virtual_file.rs
index 23e964a..83b1c82 100644
--- a/crates/vcs/src/data/vault/virtual_file.rs
+++ b/crates/vcs/src/data/vault/virtual_file.rs
@@ -70,6 +70,7 @@ impl VirtualFileVersionDescription {
}
}
+/// Virtual File Operations
impl Vault {
/// Generate a temporary path for receiving
pub fn virtual_file_temp_path(&self) -> PathBuf {