1
0
mirror of https://github.com/emilk/egui.git synced 2026-08-31 22:00:03 -04:00

Document feature flags using crate document-features (#1725)

This commit is contained in:
Emil Ernerfeldt
2022-06-09 15:27:22 +02:00
committed by GitHub
parent 218d4d4eea
commit 3169ce62d5
21 changed files with 193 additions and 83 deletions

View File

@@ -26,18 +26,22 @@ all-features = true
[features]
default = ["clipboard", "links"]
# enable cut/copy/paste to OS clipboard.
# if disabled a clipboard will be simulated so you can still copy/paste within the egui app.
## Enable cut/copy/paste to OS clipboard.
##
## If disabled a clipboard will be simulated so you can still copy/paste within the egui app.
clipboard = ["egui-winit/clipboard"]
# enable opening links in a browser when an egui hyperlink is clicked.
## Enable opening links in a browser when an egui hyperlink is clicked.
links = ["egui-winit/links"]
# experimental support for a screen reader.
## Experimental support for a screen reader.
screen_reader = ["egui-winit/screen_reader"]
[dependencies]
# Needed when generating the docs, but unfortunately also needed by `cargo check`
document-features = "0.2"
egui = { version = "0.18.0", path = "../egui", default-features = false, features = [
"bytemuck",
] }
@@ -47,6 +51,5 @@ ahash = "0.7"
bytemuck = "1.7"
glium = "0.31"
[dev-dependencies]
image = { version = "0.24", default-features = false, features = ["png"] }

View File

@@ -3,6 +3,10 @@
//! The main type you want to use is [`EguiGlium`].
//!
//! If you are writing an app, you may want to look at [`eframe`](https://docs.rs/eframe) instead.
//!
//! ## Feature flags
#![doc = document_features::document_features!()]
//!
#![allow(clippy::float_cmp)]
#![allow(clippy::manual_range_contains)]