Skip to content

Commit c52ce66

Browse files
committed
Improve documentation
1 parent c586d64 commit c52ce66

File tree

5 files changed

+15
-5
lines changed

5 files changed

+15
-5
lines changed

src/cdev_pin.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! Linux CDev pin type
1+
//! Implementation of [`embedded-hal`] digital input/output traits using a Linux CDev pin
2+
//!
3+
//! [`embedded-hal`]: https://docs.rs/embedded-hal
24
35
/// Newtype around [`gpio_cdev::LineHandle`] that implements the `embedded-hal` traits
46
///

src/i2c.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! `embedded-hal` I2C traits implementation
1+
//! Implementation of [`embedded-hal`] I2C traits
2+
//!
3+
//! [`embedded-hal`]: https://docs.rs/embedded-hal
24
35
use std::ops;
46
use std::path::{Path, PathBuf};

src/serial.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! Implementation of [`Serial`](https://docs.rs/embedded-hal/0.2.1/embedded_hal/serial/index.html)
1+
//! Implementation of [`embedded-hal`] serial traits
2+
//!
3+
//! [`embedded-hal`]: https://docs.rs/embedded-hal
24
35
use nb;
46
use serial_core;

src/sysfs_pin.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! Linux Sysfs pin type
1+
//! Implementation of [`embedded-hal`] digital input/output traits using a Linux Sysfs pin
2+
//!
3+
//! [`embedded-hal`]: https://docs.rs/embedded-hal
24
35
use std::path::Path;
46

src/timer.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! Timers.
1+
//! Implementation of [`embedded-hal`] timer traits
2+
//!
3+
//! [`embedded-hal`]: https://docs.rs/embedded-hal
24
35
use core::convert::Infallible;
46
use std::time::{Duration, Instant};

0 commit comments

Comments
 (0)