Skip to content

Commit 62a1c8a

Browse files
Svein Kristian Rougsetheldruin
authored andcommitted
Add module docstrings to remaining modules
I think it makes the docs look a little nicer when all the top-level modules have some short description, if only to expand the abbreviations
1 parent dd0ab1c commit 62a1c8a

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

src/dac.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Digital-to-analog converter
2+
13
use crate::pac::DAC;
24
use crate::{
35
gpio::{

src/ltdc.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Interface to the LCD-TFT display controller
2+
13
#[cfg_attr(test, allow(unused_imports))]
24
use micromath::F32Ext;
35

src/rng.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Interface to the true random number generator
2+
13
use core::cmp;
24
use core::mem;
35

src/serial.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Serial communication using UART/USART peripherals
2+
13
use core::fmt;
24
use core::marker::PhantomData;
35
use core::ops::Deref;

src/timer.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Interface to the timer peripherals
2+
13
#![allow(non_upper_case_globals)]
24

35
use core::convert::TryFrom;

0 commit comments

Comments
 (0)