From bb4a3f46d9d217fd71ee8a0ebdd78cc2c427fa9f Mon Sep 17 00:00:00 2001 From: 魏曹先生 <1992414357@qq.com> Date: Fri, 26 Sep 2025 14:30:57 +0800 Subject: docs: Add module-level documentation comments - Add documentation comments to VaultConfig, Sheets, and VirtualFile modules - Improve code documentation for better maintainability --- crates/vcs/src/data/vault/config.rs | 1 + crates/vcs/src/data/vault/sheets.rs | 1 + crates/vcs/src/data/vault/virtual_file.rs | 1 + 3 files changed, 3 insertions(+) (limited to 'crates/vcs/src/data/vault') 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) { 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 { -- cgit