cross-referencing examples now

Author: robamu

src/adc.rs

@@ -2,6 +2,13 @@
 //!
 //! ADC1 and ADC2 share a reset line. To initialise both of them, use the
 //! [`adc12`](adc12) method.
+//!
+//! # Examples
+//!
+//! - [Reading a voltage using ADC1](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/adc.rs)
+//! - [Reading a temperature using ADC3](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/temperature.rs)
+//! - [Using ADC1 and ADC2 together](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/adc12.rs)
+//! - [Using ADC1 and ADC2 in parallel](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/adc12_parallel.rs)
 
 use crate::hal::adc::{Channel, OneShot};
 use crate::hal::blocking::delay::DelayUs;

src/spi.rs

@@ -1,7 +1,9 @@
 //! Serial Peripheral Interface (SPI)
 //!
 //! This module implements the [embedded-hal](embedded-hal) traits for
-//! master mode SPI.
+//! master mode SPI. You can find an blocking SPI example
+//! [here](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/spi.rs) and an
+//! example using DMA [here](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/spi-dma.rs).
 //!
 //! # Usage
 //!

src/timer.rs

@@ -1,4 +1,8 @@
 //! Timers
+//!
+//! # Examples
+//!
+//! - [Blinky using a Timer](https://github.com/stm32-rs/stm32h7xx-hal/blob/master/examples/blinky_timer.rs)
 
 // TODO: on the h7x3 at least, only TIM2, TIM3, TIM4, TIM5 can support 32 bits.
 // TIM1 is 16 bit.
@@ -177,21 +181,6 @@ pub trait TimerExt<TIM> {
 }
 
 /// Hardware timers
-///
-/// # Examples
-///
-/// ```
-/// let dp = pac::Peripherals::take().unwrap();
-/// let rcc = dp.RCC.constrain();
-/// let ccdr = rcc.freeze();
-/// let mut timer = Timer::tim1(dp.TIM1, ccdr.peripheral.TIM1, &ccdr.clocks);
-/// timer.start(1.hz());
-/// loop {
-///     // Do something here and then block for 1 second
-///     // do_something();
-///     block(timer.wait()).unwrap();
-/// }
-/// ```
 #[derive(Debug)]
 pub struct Timer<TIM> {
     clk: u32,