From 2ca7e3c4b0cb293adebf9a9bf9a26191069d495d Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Thu, 28 May 2020 01:37:59 +0200
Subject: Write documentation for `iced_graphics`

---
 graphics/src/font.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'graphics/src/font.rs')

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}';
-- 
cgit