Skip to content

Commit d2dee21

Browse files
Improve crate-level docs
1 parent a4b553b commit d2dee21

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

src/lib.rs

+16-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,22 @@
44
//! STM32 microcontrollers. HALs for compatible chips can reexport this crate and implement its
55
//! traits to easily expose a featureful CAN driver.
66
//!
7-
//! Caveats:
8-
//! - Only RX FIFO 0 is supported, FIFO 1 will not be used.
7+
//! # Features
8+
//!
9+
//! - Supports both single- and dual-peripheral configurations (where one bxCAN instance manages the
10+
//! filters of a secondary instance).
11+
//! - Handles standard and extended frames, data and remote frames.
12+
//! - Support for interrupts emitted by the bxCAN peripheral.
13+
//! - Transmission respects CAN IDs and protects against priority inversion (a lower-priority frame
14+
//! may be rejected when enqueueing a higher-priority one).
15+
//! - Implements the [`embedded-can`] traits.
16+
//!
17+
//! # Limitations
18+
//!
19+
//! - Currently, only RX FIFO 0 is supported, and FIFO 1 will not be used.
20+
//! - Support for querying error states and handling error interrupts is incomplete.
21+
//!
22+
//! [`embedded-can`]: https://docs.rs/embedded-can
923
1024
#![doc(html_root_url = "https://docs.rs/bxcan/0.5.1")]
1125
// Deny a few warnings in doctests, since rustdoc `allow`s many warnings by default

0 commit comments

Comments
 (0)