document-features

Author: burrbull

Cargo.toml

@@ -49,6 +49,7 @@ systick-monotonic = { version = "1.0", optional = true }
 enumflags2 = "0.7.8"
 embedded-storage = "0.3"
 vcell = "0.1.3"
+document-features = "0.2"
 
 [dependencies.time]
 version = "0.3.14"
@@ -98,6 +99,11 @@ default-features = false
 features = ["macros"]
 
 [features]
+#! Use one of the supported STM32-serie related features:
+#! `stm32f401`, `stm32f405`, `stm32f407`, `stm32f415`, `stm32f417`, `stm32f410`,
+#! `stm32f411`, `stm32f412`, `stm32f413`, `stm32f423`, `stm32f427`, `stm32f429`,
+#! `stm32f437`, `stm32f439`, `stm32f446`, `stm32f469`, `stm32f479`.
+
 # Note: stm32f4 has only one feature for some very similar device families,
 # so it's intended for e.g. stm32f405/415 to both enable stm32f4/stm32f405.
 stm32f401 = ["stm32f4/stm32f401"]
@@ -118,18 +124,28 @@ stm32f446 = ["stm32f4/stm32f446"]
 stm32f469 = ["stm32f4/stm32f469"]
 stm32f479 = ["stm32f4/stm32f469"]
 
-usb_fs = ["synopsys-usb-otg", "synopsys-usb-otg/fs"]
-usb_hs = ["synopsys-usb-otg", "synopsys-usb-otg/hs"]
+## Support monotonic timers that can be used by [RTIC framework](https://crates.io/crates/cortex-m-rtic)
+rtic = ["dep:rtic-monotonic", "dep:systick-monotonic"]
+
+## Implementation of `defmt::Format` for public enums and structures. See [defmt](https://crates.io/crates/defmt)
+defmt = ["dep:defmt", "fugit/defmt", "nb/defmt-0-3"]
 
-can = ["bxcan"]
+## bxCAN peripheral support. See [bxcan](https://crates.io/crates/bxcan)
+can = ["dep:bxcan"]
 
-i2s = ["stm32_i2s_v12x"]
+## I2S peripheral support. See [stm32_i2s_v12x](https://crates.io/crates/stm32_i2s_v12x)
+i2s = ["dep:stm32_i2s_v12x"]
 
-fsmc_lcd = ["display-interface"]
+## USB OTG-FS peripheral support. See [synopsys-usb-otg](https://crates.io/crates/synopsys-usb-otg)
+usb_fs = ["dep:synopsys-usb-otg", "synopsys-usb-otg/fs"]
+## USB OTG-HS peripheral support. See [synopsys-usb-otg](https://crates.io/crates/synopsys-usb-otg)
+usb_hs = ["dep:synopsys-usb-otg", "synopsys-usb-otg/hs"]
 
-defmt = ["dep:defmt", "fugit/defmt", "nb/defmt-0-3"]
+## LCD support via FMC/FSMC peripheral. See [display-interface](https://crates.io/crates/display-interface)
+fsmc_lcd = ["dep:display-interface"]
 
-rtic = ["rtic-monotonic", "systick-monotonic"]
+## SDIO peripheral support. See [sdio-host](https://crates.io/crates/sdio-host)
+sdio-host = ["dep:sdio-host"]
 
 [profile.dev]
 debug = true

src/lib.rs

@@ -1,3 +1,8 @@
+//! Multi device hardware abstraction on top of the peripheral access API for the STMicro STM32F4 series microcontrollers.
+//!
+//! ## Feature flags
+#![doc = document_features::document_features!()]
+
 #![no_std]
 #![allow(non_camel_case_types)]