From 5fd597ddaf118c5e6279f6fbc304f7c876052808 Mon Sep 17 00:00:00 2001 From: Simon Hyll Date: Tue, 20 Jun 2023 04:55:14 -0700 Subject: [PATCH] docs: added banners and icons (#443) * added banners and icons * fix: formatting --- plugins/app/src/lib.rs | 9 +++++++++ plugins/authenticator/src/lib.rs | 10 ++++++++++ plugins/autostart/src/lib.rs | 8 ++++++++ plugins/cli/src/lib.rs | 11 +++++++++++ plugins/clipboard-manager/src/lib.rs | 9 +++++++++ plugins/dialog/src/lib.rs | 9 +++++++++ plugins/fs/src/lib.rs | 9 +++++++++ plugins/global-shortcut/src/lib.rs | 10 ++++++++++ plugins/http/src/lib.rs | 9 +++++++++ plugins/localhost/src/lib.rs | 11 +++++++++++ plugins/log/src/lib.rs | 7 +++++++ plugins/notification/src/lib.rs | 9 +++++++++ plugins/os/src/lib.rs | 9 +++++++++ plugins/persisted-scope/src/lib.rs | 9 +++++++++ plugins/positioner/src/lib.rs | 8 +++++++- plugins/process/src/lib.rs | 9 +++++++++ plugins/shell/src/lib.rs | 9 +++++++++ plugins/single-instance/src/lib.rs | 8 ++++++++ plugins/sql/src/lib.rs | 9 +++++++++ plugins/store/src/lib.rs | 9 +++++++++ plugins/stronghold/src/lib.rs | 9 +++++++++ plugins/updater/src/lib.rs | 11 +++++++++++ plugins/upload/src/lib.rs | 11 +++++++++++ plugins/websocket/src/lib.rs | 9 +++++++++ plugins/window-state/src/lib.rs | 8 ++++++++ plugins/window/src/lib.rs | 9 +++++++++ 26 files changed, 237 insertions(+), 1 deletion(-) diff --git a/plugins/app/src/lib.rs b/plugins/app/src/lib.rs index aa6fb802b..fbfd27d59 100644 --- a/plugins/app/src/lib.rs +++ b/plugins/app/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/app/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/app) +//! +//! This plugin provides APIs to read application metadata and macOS app visibility functions. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder, TauriPlugin}, Runtime, diff --git a/plugins/authenticator/src/lib.rs b/plugins/authenticator/src/lib.rs index 9e6785d02..92fef471b 100644 --- a/plugins/authenticator/src/lib.rs +++ b/plugins/authenticator/src/lib.rs @@ -2,6 +2,16 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/authenticator/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/authenticator) +//! +//! Use hardware security-keys in your Tauri App. +//! +//! - Supported platforms: Windows, Linux, FreeBSD, NetBSD, OpenBSD, and macOS. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] mod auth; diff --git a/plugins/autostart/src/lib.rs b/plugins/autostart/src/lib.rs index 91c6e4ece..b4338208c 100644 --- a/plugins/autostart/src/lib.rs +++ b/plugins/autostart/src/lib.rs @@ -2,6 +2,14 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/autostart/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/autostart) +//! +//! Automatically launch your application at startup. Supports Windows, Mac (via AppleScript or Launch Agent), and Linux. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] use auto_launch::{AutoLaunch, AutoLaunchBuilder}; diff --git a/plugins/cli/src/lib.rs b/plugins/cli/src/lib.rs index 096b62a2c..c666874c9 100644 --- a/plugins/cli/src/lib.rs +++ b/plugins/cli/src/lib.rs @@ -2,6 +2,17 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/cli/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/cli) +//! +//! Parse arguments from your Command Line Interface. +//! +//! - Supported platforms: Windows, Linux and macOS. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder, PluginApi, TauriPlugin}, AppHandle, Manager, Runtime, State, diff --git a/plugins/clipboard-manager/src/lib.rs b/plugins/clipboard-manager/src/lib.rs index 7fc053480..d4ccdb0ab 100644 --- a/plugins/clipboard-manager/src/lib.rs +++ b/plugins/clipboard-manager/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/clipboard-manager/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/clipboard-manager) +//! +//! Read and write to the system clipboard. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder, TauriPlugin}, Manager, Runtime, diff --git a/plugins/dialog/src/lib.rs b/plugins/dialog/src/lib.rs index 8353b71c3..4cf37c011 100644 --- a/plugins/dialog/src/lib.rs +++ b/plugins/dialog/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/dialog/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/dialog) +//! +//! Native system dialogs for opening and saving files along with message dialogs. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use serde::{Deserialize, Serialize}; use tauri::{ plugin::{Builder, TauriPlugin}, diff --git a/plugins/fs/src/lib.rs b/plugins/fs/src/lib.rs index 9156661f7..aab60ce99 100644 --- a/plugins/fs/src/lib.rs +++ b/plugins/fs/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/fs/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/fs) +//! +//! Access the file system. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use config::FsScope; use tauri::{ plugin::{Builder as PluginBuilder, TauriPlugin}, diff --git a/plugins/global-shortcut/src/lib.rs b/plugins/global-shortcut/src/lib.rs index 86fb28dd0..96fab9d83 100644 --- a/plugins/global-shortcut/src/lib.rs +++ b/plugins/global-shortcut/src/lib.rs @@ -2,6 +2,16 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/global-shortcut/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/global-shortcut) +//! +//! Register global shortcuts. +//! +//! - Supported platforms: Windows, Linux and macOS. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] use std::{ diff --git a/plugins/http/src/lib.rs b/plugins/http/src/lib.rs index d63107cc0..8b9b2d577 100644 --- a/plugins/http/src/lib.rs +++ b/plugins/http/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/http/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/http) +//! +//! Access the HTTP client written in Rust. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use config::{Config, HttpAllowlistScope}; pub use reqwest as client; use tauri::{ diff --git a/plugins/localhost/src/lib.rs b/plugins/localhost/src/lib.rs index e34a9ace2..c0b42a299 100644 --- a/plugins/localhost/src/lib.rs +++ b/plugins/localhost/src/lib.rs @@ -2,6 +2,17 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/localhost/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/localhost) +//! +//! Expose your apps assets through a localhost server instead of the default custom protocol. +//! +//! **Note: This plugins brings considerable security risks and you should only use it if you know what your are doing. If in doubt, use the default custom protocol implementation.** + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use std::collections::HashMap; use http::Uri; diff --git a/plugins/log/src/lib.rs b/plugins/log/src/lib.rs index 05794dd7e..4ba428e56 100644 --- a/plugins/log/src/lib.rs +++ b/plugins/log/src/lib.rs @@ -2,8 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/log/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/log) +//! //! Logging for Tauri applications. +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use fern::{Filter, FormatCallback}; use log::{logger, RecordBuilder}; use log::{LevelFilter, Record}; diff --git a/plugins/notification/src/lib.rs b/plugins/notification/src/lib.rs index 03f6db09c..b1e284744 100644 --- a/plugins/notification/src/lib.rs +++ b/plugins/notification/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/notification/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/notification) +//! +//! Send message notifications (brief auto-expiring OS window element) to your user. Can also be used with the Notification Web API. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use serde::Serialize; #[cfg(mobile)] use tauri::plugin::PluginHandle; diff --git a/plugins/os/src/lib.rs b/plugins/os/src/lib.rs index c66580d12..fab629d59 100644 --- a/plugins/os/src/lib.rs +++ b/plugins/os/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/os/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/os) +//! +//! Read information about the operating system. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use std::fmt::Display; pub use os_info::Version; diff --git a/plugins/persisted-scope/src/lib.rs b/plugins/persisted-scope/src/lib.rs index f1e02c188..7e3be977d 100644 --- a/plugins/persisted-scope/src/lib.rs +++ b/plugins/persisted-scope/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/persisted-scope/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/persisted-scope) +//! +//! Save filesystem and asset scopes and restore them when the app is reopened. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use aho_corasick::AhoCorasick; use serde::{Deserialize, Serialize}; use tauri::{ diff --git a/plugins/positioner/src/lib.rs b/plugins/positioner/src/lib.rs index b7f83c418..0a412d9a0 100644 --- a/plugins/positioner/src/lib.rs +++ b/plugins/positioner/src/lib.rs @@ -3,14 +3,20 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/positioner/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/positioner) +//! //! A plugin for Tauri that helps position your windows at well-known locations. //! //! # Cargo features //! //! - **system-tray**: Enables system-tray-relative positions. -//! +//! //! Note: This requires attaching the Tauri plugin, *even* when using the trait extension only. +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] mod ext; diff --git a/plugins/process/src/lib.rs b/plugins/process/src/lib.rs index d6c327b39..2de829140 100644 --- a/plugins/process/src/lib.rs +++ b/plugins/process/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/process/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/process) +//! +//! This plugin provides APIs to access the current process. To spawn child processes, see the [`shell`](https://github.com/tauri-apps/tauri-plugin-shell) plugin. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder, TauriPlugin}, Runtime, diff --git a/plugins/shell/src/lib.rs b/plugins/shell/src/lib.rs index d7637ea5b..fbc2683f6 100644 --- a/plugins/shell/src/lib.rs +++ b/plugins/shell/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/shell/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/shell) +//! +//! Access the system shell. Allows you to spawn child processes and manage files and URLs using their default application. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use std::{ collections::HashMap, sync::{Arc, Mutex}, diff --git a/plugins/single-instance/src/lib.rs b/plugins/single-instance/src/lib.rs index 6b20956e0..715c894e1 100644 --- a/plugins/single-instance/src/lib.rs +++ b/plugins/single-instance/src/lib.rs @@ -2,6 +2,14 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/single-instance/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/single-instance) +//! +//! Ensure a single instance of your tauri app is running. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] use tauri::{plugin::TauriPlugin, AppHandle, Manager, Runtime}; diff --git a/plugins/sql/src/lib.rs b/plugins/sql/src/lib.rs index 4bc873249..f25ede21d 100644 --- a/plugins/sql/src/lib.rs +++ b/plugins/sql/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/sql/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/sql) +//! +//! Interface with SQL databases through [sqlx](https://github.com/launchbadge/sqlx). It supports the `sqlite`, `mysql` and `postgres` drivers, enabled by a Cargo feature. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + #[cfg(any( all(feature = "sqlite", feature = "mysql"), all(feature = "sqlite", feature = "postgres"), diff --git a/plugins/store/src/lib.rs b/plugins/store/src/lib.rs index 1ce2885ed..3569f2736 100644 --- a/plugins/store/src/lib.rs +++ b/plugins/store/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/store/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/store) +//! +//! Simple, persistent key-value store. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + pub use error::Error; use log::warn; use serde::Serialize; diff --git a/plugins/stronghold/src/lib.rs b/plugins/stronghold/src/lib.rs index 37322cc67..96489c849 100644 --- a/plugins/stronghold/src/lib.rs +++ b/plugins/stronghold/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/stronghold/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/stronghold) +//! +//! Store secrets and keys using the [IOTA Stronghold](https://github.com/iotaledger/stronghold.rs) encrypted database and secure runtime. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use std::{ collections::HashMap, fmt, diff --git a/plugins/updater/src/lib.rs b/plugins/updater/src/lib.rs index 3b511ca45..e9de66434 100644 --- a/plugins/updater/src/lib.rs +++ b/plugins/updater/src/lib.rs @@ -2,6 +2,17 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/updater/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/updater) +//! +//! In-app updates for Tauri applications. +//! +//! - Supported platforms: Windows, Linux and macOS.crypted database and secure runtime. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder as PluginBuilder, TauriPlugin}, Manager, Runtime, diff --git a/plugins/upload/src/lib.rs b/plugins/upload/src/lib.rs index 698549afe..fb139a3e2 100644 --- a/plugins/upload/src/lib.rs +++ b/plugins/upload/src/lib.rs @@ -2,6 +2,17 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/upload/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/upload) +//! +//! Upload files from disk to a remote server over HTTP. +//! +//! Download files from a remote HTTP server to disk. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use futures_util::TryStreamExt; use serde::{ser::Serializer, Serialize}; use tauri::{ diff --git a/plugins/websocket/src/lib.rs b/plugins/websocket/src/lib.rs index a3b941365..31d744c38 100644 --- a/plugins/websocket/src/lib.rs +++ b/plugins/websocket/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/websocket/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/websocket) +//! +//! Expose a WebSocket server to your Tauri frontend. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use futures_util::{stream::SplitSink, SinkExt, StreamExt}; use serde::{ser::Serializer, Deserialize, Serialize}; use tauri::{ diff --git a/plugins/window-state/src/lib.rs b/plugins/window-state/src/lib.rs index fa88be3bb..98d58a9f7 100644 --- a/plugins/window-state/src/lib.rs +++ b/plugins/window-state/src/lib.rs @@ -2,6 +2,14 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/window-state/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/window-state) +//! +//! Save window positions and sizes and restore them when the app is reopened. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] #![cfg(not(any(target_os = "android", target_os = "ios")))] use bitflags::bitflags; diff --git a/plugins/window/src/lib.rs b/plugins/window/src/lib.rs index 722a9924c..be545b88c 100644 --- a/plugins/window/src/lib.rs +++ b/plugins/window/src/lib.rs @@ -2,6 +2,15 @@ // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT +//! [![](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/window/banner.png)](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/window) +//! +//! Interact with the Tauri window. + +#![doc( + html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", + html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png" +)] + use tauri::{ plugin::{Builder, TauriPlugin}, Runtime,