chore: update documentation

plugins/deep-link/src/error.rs

@@ -4,25 +4,38 @@
 
 use serde::{ser::Serializer, Serialize};
 
+/// Alias for a [`Result`](std::result::Result) with the error type [`Error`].
 pub type Result<T> = std::result::Result<T, Error>;
 
+/// The error type for this plugin.
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
+    /// The requested operation (usually registering or unregistering a protocol scheme at
+    /// runtime) is not supported on the current platform.
     #[error("unsupported platform")]
     UnsupportedPlatform,
+    /// Transparent wrapper around an [`std::io::Error`].
     #[error(transparent)]
     Io(#[from] std::io::Error),
+    /// Transparent wrapper around a [`tauri::Error`].
     #[error(transparent)]
     Tauri(#[from] tauri::Error),
+    /// Transparent wrapper around a [`windows_result::Error`]. Only used on Windows.
     #[cfg(target_os = "windows")]
     #[error(transparent)]
     Windows(#[from] windows_result::Error),
+    /// Transparent wrapper around an [`ini::Error`], returned when reading or writing the
+    /// `.desktop` file used to register a protocol scheme. Only used on Linux.
     #[cfg(target_os = "linux")]
     #[error(transparent)]
     Ini(#[from] ini::Error),
+    /// Transparent wrapper around an [`ini::ParseError`], returned when parsing the
+    /// `.desktop` file used to register a protocol scheme. Only used on Linux.
     #[cfg(target_os = "linux")]
     #[error(transparent)]
     ParseIni(#[from] ini::ParseError),
+    /// Transparent wrapper around a [`tauri::plugin::mobile::PluginInvokeError`], returned
+    /// when the underlying mobile plugin invocation fails. Only used on mobile.
     #[cfg(mobile)]
     #[error(transparent)]
     PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),

plugins/deep-link/src/lib.rs

@@ -2,6 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+//! Set your Tauri application as the default handler for a URL, or check which URL(s) it was
+//! opened with.
+//!
+//! On Windows and Linux, protocol schemes can additionally be registered and unregistered at
+//! runtime with [`DeepLink::register`] and [`DeepLink::unregister`]. On macOS, Android and iOS
+//! the schemes declared in the Tauri configuration are registered at build time instead, so
+//! calling those methods returns [`Error::UnsupportedPlatform`].
+
 use tauri::{
     plugin::{Builder, PluginApi, TauriPlugin},
     AppHandle, EventId, Listener, Manager, Runtime,
@@ -479,6 +487,7 @@ use url::Url;
 
 /// Extensions to [`tauri::App`], [`tauri::AppHandle`], [`tauri::WebviewWindow`], [`tauri::Webview`] and [`tauri::Window`] to access the deep-link APIs.
 pub trait DeepLinkExt<R: Runtime> {
+    /// Returns a reference to the [`DeepLink`] API.
     fn deep_link(&self) -> &DeepLink<R>;
 }