Skip to content

Commit 9b8369e

Browse files
committed
chore: update doc.
1 parent 4134c43 commit 9b8369e

4 files changed

Lines changed: 17 additions & 1 deletion

File tree

2

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
chore: document behaviors and requirements.
2+
# Please enter the commit message for your changes. Lines starting
3+
# with '#' will be ignored, and an empty message aborts the commit.
4+
#
5+
# On branch feat/recent-doc
6+
# Your branch is up to date with 'origin/feat/recent-doc'.
7+
#
8+
# Changes to be committed:
9+
# modified: plugins/recent-doc/guest-js/index.ts
10+
# modified: plugins/recent-doc/src/commands.rs
11+
#

plugins/recent-doc/guest-js/index.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ import { invoke } from '@tauri-apps/api/core'
1313
/**
1414
* Adds a document to this app's recent documents list.
1515
*
16+
* #### Requirements
17+
*
18+
* - `path` must be a local filesystem path.
19+
* - For installer-based Windows builds, define handled extensions in `tauri.conf.json` at `bundle.fileAssociations` so associations are created on install and removed on uninstall.
20+
*
1621
* #### Platform-specific
1722
*
1823
* - **Linux / Android / iOS:** Unsupported.

plugins/recent-doc/src/commands.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ impl Drop for ComGuard {
5959
///
6060
/// - This API is supported on Windows and macOS only.
6161
/// - `path` should be a local filesystem path that the operating system can resolve.
62+
/// - For installer-based Windows builds, declare handled extensions in `tauri.conf.json` under `bundle.fileAssociations` so install/uninstall manages associations automatically.
6263
///
6364
/// # Errors
6465
///

plugins/recent-doc/src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ mod commands;
66
mod error;
77

88
pub use commands::{add_recent_document, clear_recent_documents, get_recent_documents};
9-
109
pub use error::{Error, Result};
1110

1211
use tauri::{

0 commit comments

Comments
 (0)