From 51856e9e0acbbfa26416a3899d20eced367684ee Mon Sep 17 00:00:00 2001 From: Fabian-Lars Date: Wed, 13 Nov 2024 16:07:29 +0100 Subject: [PATCH] docs: Remove header image from inline docs (#2045) --- plugins/autostart/src/lib.rs | 2 -- plugins/cli/src/lib.rs | 2 -- plugins/clipboard-manager/src/lib.rs | 2 -- plugins/dialog/src/lib.rs | 2 -- plugins/fs/src/lib.rs | 2 -- plugins/global-shortcut/src/lib.rs | 2 -- plugins/http/src/lib.rs | 2 -- plugins/localhost/src/lib.rs | 2 -- plugins/log/src/lib.rs | 2 -- plugins/notification/src/lib.rs | 2 -- plugins/os/src/lib.rs | 2 -- plugins/persisted-scope/src/lib.rs | 2 -- plugins/positioner/src/lib.rs | 2 -- plugins/process/src/lib.rs | 2 -- plugins/shell/src/lib.rs | 2 -- plugins/single-instance/src/lib.rs | 2 -- plugins/sql/src/lib.rs | 2 -- plugins/store/src/lib.rs | 2 -- plugins/stronghold/src/lib.rs | 2 -- plugins/updater/src/lib.rs | 2 -- plugins/upload/src/lib.rs | 2 -- plugins/websocket/src/lib.rs | 4 +--- plugins/window-state/src/lib.rs | 2 -- 23 files changed, 1 insertion(+), 47 deletions(-) diff --git a/plugins/autostart/src/lib.rs b/plugins/autostart/src/lib.rs index bd3866b31..c0cf295d6 100644 --- a/plugins/autostart/src/lib.rs +++ b/plugins/autostart/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/cli/src/lib.rs b/plugins/cli/src/lib.rs index 38f64f835..3e1443769 100644 --- a/plugins/cli/src/lib.rs +++ b/plugins/cli/src/lib.rs @@ -2,8 +2,6 @@ // 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. diff --git a/plugins/clipboard-manager/src/lib.rs b/plugins/clipboard-manager/src/lib.rs index 3924d7f1e..133020d9d 100644 --- a/plugins/clipboard-manager/src/lib.rs +++ b/plugins/clipboard-manager/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/dialog/src/lib.rs b/plugins/dialog/src/lib.rs index 3d7464d90..9a36c317b 100644 --- a/plugins/dialog/src/lib.rs +++ b/plugins/dialog/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/fs/src/lib.rs b/plugins/fs/src/lib.rs index a1cf27669..b48b24dcb 100644 --- a/plugins/fs/src/lib.rs +++ b/plugins/fs/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/global-shortcut/src/lib.rs b/plugins/global-shortcut/src/lib.rs index 5868ff9dc..450bb5985 100644 --- a/plugins/global-shortcut/src/lib.rs +++ b/plugins/global-shortcut/src/lib.rs @@ -2,8 +2,6 @@ // 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. diff --git a/plugins/http/src/lib.rs b/plugins/http/src/lib.rs index cdffeb6e1..d775760cd 100644 --- a/plugins/http/src/lib.rs +++ b/plugins/http/src/lib.rs @@ -2,8 +2,6 @@ // 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. pub use reqwest; diff --git a/plugins/localhost/src/lib.rs b/plugins/localhost/src/lib.rs index ae77cd806..5b00087fa 100644 --- a/plugins/localhost/src/lib.rs +++ b/plugins/localhost/src/lib.rs @@ -2,8 +2,6 @@ // 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.** diff --git a/plugins/log/src/lib.rs b/plugins/log/src/lib.rs index 6df4e1c20..6b07c9d26 100644 --- a/plugins/log/src/lib.rs +++ b/plugins/log/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/notification/src/lib.rs b/plugins/notification/src/lib.rs index aa15cc933..5cc303196 100644 --- a/plugins/notification/src/lib.rs +++ b/plugins/notification/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/os/src/lib.rs b/plugins/os/src/lib.rs index 98813578c..913d17420 100644 --- a/plugins/os/src/lib.rs +++ b/plugins/os/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/persisted-scope/src/lib.rs b/plugins/persisted-scope/src/lib.rs index d9988f8e1..f8dd8ab9d 100644 --- a/plugins/persisted-scope/src/lib.rs +++ b/plugins/persisted-scope/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/positioner/src/lib.rs b/plugins/positioner/src/lib.rs index 81bfaef83..df5eef18b 100644 --- a/plugins/positioner/src/lib.rs +++ b/plugins/positioner/src/lib.rs @@ -3,8 +3,6 @@ // 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 diff --git a/plugins/process/src/lib.rs b/plugins/process/src/lib.rs index e0e948fc8..b83d89648 100644 --- a/plugins/process/src/lib.rs +++ b/plugins/process/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/shell/src/lib.rs b/plugins/shell/src/lib.rs index 1ec90e2e1..f5458dd1f 100644 --- a/plugins/shell/src/lib.rs +++ b/plugins/shell/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/single-instance/src/lib.rs b/plugins/single-instance/src/lib.rs index ce7815e83..03fd1ed7b 100644 --- a/plugins/single-instance/src/lib.rs +++ b/plugins/single-instance/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/sql/src/lib.rs b/plugins/sql/src/lib.rs index 352ffbec5..e19b72a78 100644 --- a/plugins/sql/src/lib.rs +++ b/plugins/sql/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/store/src/lib.rs b/plugins/store/src/lib.rs index 310e80ecd..4b1b47bcd 100644 --- a/plugins/store/src/lib.rs +++ b/plugins/store/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/stronghold/src/lib.rs b/plugins/stronghold/src/lib.rs index 29ad870fb..3454a662a 100644 --- a/plugins/stronghold/src/lib.rs +++ b/plugins/stronghold/src/lib.rs @@ -2,8 +2,6 @@ // 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( diff --git a/plugins/updater/src/lib.rs b/plugins/updater/src/lib.rs index b45f91a2c..4dbd26e19 100644 --- a/plugins/updater/src/lib.rs +++ b/plugins/updater/src/lib.rs @@ -2,8 +2,6 @@ // 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. diff --git a/plugins/upload/src/lib.rs b/plugins/upload/src/lib.rs index d8f5f43c4..d6aa3fb91 100644 --- a/plugins/upload/src/lib.rs +++ b/plugins/upload/src/lib.rs @@ -2,8 +2,6 @@ // 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. diff --git a/plugins/websocket/src/lib.rs b/plugins/websocket/src/lib.rs index 2ce02e810..9c7b9f24e 100644 --- a/plugins/websocket/src/lib.rs +++ b/plugins/websocket/src/lib.rs @@ -2,9 +2,7 @@ // 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. +//! Open a WebSocket connection using a Rust client in JS. #![doc( html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png", diff --git a/plugins/window-state/src/lib.rs b/plugins/window-state/src/lib.rs index 82beb9f4e..8c675d4da 100644 --- a/plugins/window-state/src/lib.rs +++ b/plugins/window-state/src/lib.rs @@ -2,8 +2,6 @@ // 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(