Link to examples in documentation

Author: Sh3Rm4n

src/adc.rs

@@ -1,9 +1,14 @@
 //! API for the ADC (Analog to Digital Converter)
 //!
 //! # Examples
-//! Check `adc.rs` in the examples folder.
+//!
+//! Check out [examles/adc.rs].
+//!
 //! It can be built for the STM32F3Discovery running
 //! `cargo build --example adc --features=stm32f303xc`
+//!
+//! [examples/adc.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/adc.rs
+
 use crate::{
     gpio::Analog,
     rcc::{Clocks, AHB},

src/can.rs

@@ -6,6 +6,11 @@
 //! It is a implementation of the [`embedded_hal_can`][can] traits.
 //!
 //! [can]: embedded_hal_can
+//!
+//! A usage example of the can peripheral can be found at [examples/can.rs]
+//!
+//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/can.rs
+
 pub use embedded_hal_can::{self, Filter, Frame, Id, Receiver, Transmitter};
 
 use crate::gpio::gpioa;

src/dma.rs

@@ -1,6 +1,10 @@
 //! Direct memory access (DMA) controller
 //!
 //! Currently DMA is only supported for STM32F303 MCUs.
+//!
+//! An example how to use DMA for serial, can be found at [examples/serial_dma.rs]
+//!
+//! [examples/serial_dma.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/serial_dma.rs
 
 // To learn about most of the ideas implemented here, check out the DMA section
 // of the Embedonomicon: https://docs.rust-embedded.org/embedonomicon/dma.html

src/gpio.rs

@@ -26,7 +26,7 @@
 //!
 //! [InputPin]: embedded_hal::digital::v2::InputPin
 //! [OutputPin]: embedded_hal::digital::v2::OutputPin
-//! [examples/toggle.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.4.3/examples/toggle.rs
+//! [examples/toggle.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/toggle.rs
 
 use core::convert::Infallible;
 use core::marker::PhantomData;

src/i2c.rs

@@ -1,4 +1,8 @@
 //! Inter-Integrated Circuit (I2C) bus
+//!
+//! A usage example of the i2c peripheral can be found at [examples/i2c_scanner.rs]
+//!
+//! [examples/i2c_scanner.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/i2c_scanner.rs
 
 use core::convert::TryFrom;
 use core::ops::Deref;

src/pwm.rs

@@ -149,6 +149,10 @@
   Once we've connected a complementary pin (PA7) we are now _only_
   allowed to use other complementary pins.  PA8 is a valid choice if
   we have no pins in use, but it cannot be used once we've used PA7.
+
+  A usage example can be found at [examples/pwm.rs]
+
+  [examples/pwm.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/pwm.rs
 */
 
 use crate::{

src/spi.rs

@@ -1,4 +1,8 @@
 //! Serial Peripheral Interface (SPI) bus
+//!
+//! A usage example of the can peripheral can be found at [examples/spi.rs]
+//!
+//! [examples/spi.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/spi.rs
 
 use core::ptr;
 

src/usb.rs

@@ -2,8 +2,9 @@
 //!
 //! Requires the `stm32-usbd` feature and one of the `stm32f303x*` features.
 //!
-//! See <https://github.com/stm32-rs/stm32f3xx-hal/tree/master/examples>
-//! for usage examples.
+//! See [examples/usb_serial.rs] for a usage example.
+//!
+//! [examples/usb_serial.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/usb_serial.rs
 
 use crate::pac::{RCC, USB};
 use stm32_usbd::UsbPeripheral;

src/watchdog.rs

@@ -1,4 +1,8 @@
 //! Watchdog
+//!
+//! A usage example of the watchdog can be found at [examples/can.rs]
+//!
+//! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.5.0/examples/can.rs
 
 use crate::hal::watchdog::{Watchdog, WatchdogEnable};