summaryrefslogtreecommitdiffstats
path: root/graphics/src/font.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:37:59 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:40:30 +0200
commit2ca7e3c4b0cb293adebf9a9bf9a26191069d495d (patch)
tree653a1f24422079231ff5a9f0d868c7d117ca92ed /graphics/src/font.rs
parent45511a442f707e93fe6e568d2100756b63af7362 (diff)
downloadiced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.tar.gz
iced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.tar.bz2
iced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.zip
Write documentation for `iced_graphics`
Diffstat (limited to 'graphics/src/font.rs')
-rw-r--r--graphics/src/font.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/graphics/src/font.rs b/graphics/src/font.rs
index a490e609..bcc28857 100644
--- a/graphics/src/font.rs
+++ b/graphics/src/font.rs
@@ -1,22 +1,33 @@
+//! Find system fonts or use the built-in ones.
#[cfg(feature = "font-source")]
mod source;
#[cfg(feature = "font-source")]
+#[cfg_attr(docsrs, doc(cfg(feature = "font-source")))]
pub use source::Source;
#[cfg(feature = "font-source")]
+#[cfg_attr(docsrs, doc(cfg(feature = "font-source")))]
pub use font_kit::{
error::SelectionError as LoadError, family_name::FamilyName as Family,
};
+/// A built-in fallback font, for convenience.
#[cfg(feature = "font-fallback")]
+#[cfg_attr(docsrs, doc(cfg(feature = "font-fallback")))]
pub const FALLBACK: &[u8] = include_bytes!("../fonts/Lato-Regular.ttf");
+/// A built-in icon font, for convenience.
#[cfg(feature = "font-icons")]
+#[cfg_attr(docsrs, doc(cfg(feature = "font-icons")))]
pub const ICONS: iced_native::Font = iced_native::Font::External {
name: "iced_wgpu icons",
bytes: include_bytes!("../fonts/Icons.ttf"),
};
+/// The `char` representing a ✔ icon in the built-in [`ICONS`] font.
+///
+/// [`ICONS`]: const.ICONS.html
#[cfg(feature = "font-icons")]
+#[cfg_attr(docsrs, doc(cfg(feature = "font-icons")))]
pub const CHECKMARK_ICON: char = '\u{F00C}';