Highlight required features for some modules

And additional documentation improvments

Author: Sh3Rm4n

src/adc.rs

@@ -1,8 +1,8 @@
-//! API for the ADC (Analog to Digital Converter)
+//! Analog to Digital Converter. (Requires feature `stm32f303x[bcde]`)
 //!
 //! # Examples
 //!
-//! Check out [examles/adc.rs].
+//! Check out [examles/adc.rs][].
 //!
 //! It can be built for the STM32F3Discovery running
 //! `cargo build --example adc --features=stm32f303xc`

src/can.rs

@@ -1,4 +1,4 @@
-//! Controller Area Network
+//! Controller Area Network (Requires feature `can`)
 //!
 //! CAN is currently not enabled by default, and
 //! can be enabled by the `can` feature.
@@ -25,8 +25,10 @@ pub use pac::can::btr::LBKM_A;
 const EXID_MASK: u32 = 0b1_1111_1111_1100_0000_0000_0000_0000;
 const MAX_EXTENDED_ID: u32 = 0x1FFF_FFFF;
 
-/// Options the CAN bus. This is primarily used to set bus timings, but also controls options like enabling loopback or silent mode for debugging.
-/// See  http://www.bittiming.can-wiki.info/#bxCAN for generating the timing parameters for different baud rates and clocks.
+/// Options for the CAN bus.
+///
+/// This is primarily used to set bus timings, but also controls options like enabling loopback or silent mode for debugging.
+/// See  <http://www.bittiming.can-wiki.info/#bxCAN> for generating the timing parameters for different baud rates and clocks.
 ///
 /// Use `CanOpts::default()` to get 250kbps at 32mhz system clock
 pub struct CanOpts {
@@ -43,25 +45,25 @@ impl CanOpts {
         CanOpts::default()
     }
 
-    /// Set the Baud Rate Prescaler. See  http://www.bittiming.can-wiki.info/#bxCAN for generating the timing parameters for different baud rates and clocks.
+    /// Set the Baud Rate Prescaler. See  <http://www.bittiming.can-wiki.info/#bxCAN> for generating the timing parameters for different baud rates and clocks.
     pub fn brp(mut self, brp: u16) -> Self {
         self.brp = brp;
         self
     }
 
-    /// Set the Resynchronisation Jump Width. See  http://www.bittiming.can-wiki.info/#bxCAN for generating the timing parameters for different baud rates and clocks.
+    /// Set the Resynchronisation Jump Width. See  <http://www.bittiming.can-wiki.info/#bxCAN> for generating the timing parameters for different baud rates and clocks.
     pub fn sjw(mut self, sjw: u8) -> Self {
         self.sjw = sjw;
         self
     }
 
-    /// Set Time Segment One. See  http://www.bittiming.can-wiki.info/#bxCAN for generating the timing parameters for different baud rates and clocks.
+    /// Set Time Segment One. See  <http://www.bittiming.can-wiki.info/#bxCAN> for generating the timing parameters for different baud rates and clocks.
     pub fn ts1(mut self, ts1: u8) -> Self {
         self.ts1 = ts1;
         self
     }
 
-    /// Set Time Segment Two. See  http://www.bittiming.can-wiki.info/#bxCAN for generating the timing parameters for different baud rates and clocks.
+    /// Set Time Segment Two. See  <http://www.bittiming.can-wiki.info/#bxCAN> for generating the timing parameters for different baud rates and clocks.
     pub fn ts2(mut self, ts2: u8) -> Self {
         self.ts2 = ts2;
         self

src/dma.rs

@@ -1,6 +1,6 @@
-//! Direct memory access (DMA) controller
+//! Direct memory access (DMA) controller. (Requires feature `stm32f303*` or `stm32f302*`)
 //!
-//! Currently DMA is only supported for STM32F303 MCUs.
+//! Currently DMA is only supported for STM32F303 or STM32F302 MCUs.
 //!
 //! An example how to use DMA for serial, can be found at [examples/serial_dma.rs]
 //!

src/lib.rs

@@ -47,25 +47,25 @@
 
  [README]: https://github.com/stm32-rs/stm32f3xx-hal/blob/master/README.md#selecting-the-right-chip
 
- ### ld
+ ### `ld`
 
  When this feature is enabled the `memory.x` linker script for target chip is automatically
  provided by this crate. See [`cortex-m-rt` document][memoryx] for more info.
 
  [memoryx]: https://docs.rs/cortex-m-rt/0.6.13/cortex_m_rt/#memoryx
 
- ### rt
+ ### `rt`
 
  This feature enables [`stm32f3`][]'s `rt` feature. See [`cortex-m-rt` document][device] for more info.
 
  [`stm32f3`]: https://crates.io/crates/stm32f3
  [device]: https://docs.rs/cortex-m-rt/0.6.13/cortex_m_rt/#device
 
- ### can
+ ### `can`
 
  Enable CAN peripherals on supported targets.
 
- ### stm32-usbd
+ ### `stm32-usbd`
 
  Enable USB peripherals on supported targets.
 
@@ -120,7 +120,7 @@ pub use stm32f3::stm32f373 as pac;
 #[cfg(feature = "svd-f3x4")]
 pub use stm32f3::stm32f3x4 as pac;
 
-/// Enable use of interrupt macro
+/// Enable use of interrupt macro. (Requires feature `rt`)
 #[cfg(feature = "rt")]
 pub use crate::pac::interrupt;
 

src/spi.rs

@@ -9,10 +9,10 @@ use core::ptr;
 use crate::hal::spi::FullDuplex;
 pub use crate::hal::spi::{Mode, Phase, Polarity};
 use crate::pac::{
+    spi1,
     spi1::cr2::{DS_A, FRXTH_A},
     SPI1, SPI2, SPI3,
 };
-use crate::stm32::spi1;
 
 #[cfg(any(
     feature = "stm32f302xd",

src/usb.rs

@@ -1,6 +1,4 @@
-//! USB peripheral
-//!
-//! Requires the `stm32-usbd` feature and one of the `stm32f303x*` features.
+//! USB peripheral. (Requires feature `stm32-usbd`)
 //!
 //! See [examples/usb_serial.rs] for a usage example.
 //!