Add features list to crate docs.

servo · Aug 19, 2023 · 1ac1069 · 1ac1069
1 parent c9cae88
commit 1ac1069
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/harfbuzz-sys/src/lib.rs b/harfbuzz-sys/src/lib.rs
@@ -1,3 +1,14 @@
+//! # harfbuzz-sys
+//!
+//! This crate provides raw bindings to the [HarfBuzz](https://harfbuzz.github.io/)
+//! text shaping library.
+//!
+//! ## Features
+//!
+//! - `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
+//! - `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
+//! - `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)
+
 #[cfg(all(target_vendor = "apple", feature = "coretext"))]
 pub mod coretext;
 

diff --git a/harfbuzz/src/lib.rs b/harfbuzz/src/lib.rs
@@ -9,6 +9,12 @@
 
 //! HarfBuzz is a text shaping engine. It solves the problem of selecting
 //! and positioning glyphs from a font given a Unicode string.
+//!
+//! ## Features
+//!
+//! - `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
+//! - `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
+//! - `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)
 
 #![warn(missing_docs)]
 #![deny(