فهرست منبع

chore(docs): document cargo features [skip ci]

Lucas Nogueira 4 سال پیش
والد
کامیت
4937741d33
2فایلهای تغییر یافته به همراه12 افزوده شده و 1 حذف شده
  1. 1 1
      core/tauri-utils/src/config.rs
  2. 11 0
      core/tauri/src/lib.rs

+ 1 - 1
core/tauri-utils/src/config.rs

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 //! The Tauri configuration used at runtime.
-//! It is pulled from a `tauri.conf.json` file and the [`Config`] struct is generated at compile time.
+//! It is pulled from a `tauri.conf.json` file and the [`config::Config`] struct is generated at compile time.
 //!
 //! # Stability
 //! This is a core functionality that is not considered part of the stable API.

+ 11 - 0
core/tauri/src/lib.rs

@@ -5,6 +5,17 @@
 //! Tauri is a framework for building tiny, blazing fast binaries for all major desktop platforms.
 //! Developers can integrate any front-end framework that compiles to HTML, JS and CSS for building their user interface.
 //! The backend of the application is a rust-sourced binary with an API that the front-end can interact with.
+//!
+//! # Cargo features
+//!
+//! The following are a list of Cargo features that can be enabled or disabled:
+//!
+//! - **wry** *(enabled by default)*: Enables the [wry](https://github.com/tauri-apps/wry) runtime. Only disable it if you want a custom runtime.
+//! - **menu**: Enables application menus support.
+//! - **reqwest-client**: Uses `reqwest` as HTTP client on the `http` APIs. Improves performance, but increases the bundle size.
+//! - **cli**: Enables usage of `clap` for CLI argument parsing. Enabled by default if the `cli` config is defined on the `tauri.conf.json` file.
+//! - **system-tray**: Enables application system tray API. Enabled by default if the `systemTray` config is defined on the `tauri.conf.json` file.
+//! - **updater**: Enables the application auto updater. Enabled by default if the `updater` config is defined on the `tauri.conf.json` file.
 
 #![warn(missing_docs, rust_2018_idioms)]
 #![cfg_attr(doc_cfg, feature(doc_cfg))]