Skip to content

Commit

Permalink
#5 comment out empty lines in rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
HusseinAbdelhamid committed Oct 1, 2024
1 parent 9562399 commit 0b95c28
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion src/can.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//!# use mcp2517::can::MCP2517;
//!# use mcp2517::config::Configuration;
//!# use mcp2517::example::*;
//!
//!#
//! let sys_clk = ExampleClock::default();
//! let spi_bus = ExampleSPIBus::default();
//! let cs_pin = ExampleCSPin{};
Expand Down
6 changes: 3 additions & 3 deletions src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//! attemps are set to be unlimited.
//!```
//!# use mcp2517::config::{FifoConfiguration,PayloadSize,RetransmissionAttempts};
//!
//!#
//! let fifo_config = FifoConfiguration{
//! pl_size: PayloadSize::EightBytes,
//! rx_size: 10,
Expand All @@ -28,7 +28,7 @@
//!
//!```
//!# use mcp2517::config::{ClockConfiguration, ClockOutputDivisor, PLLSetting, SystemClockDivisor};
//!
//!#
//! let clock_config = ClockConfiguration{
//! clock_output: ClockOutputDivisor::DivideBy2,
//! system_clock: SystemClockDivisor::DivideBy1,
Expand All @@ -41,7 +41,7 @@
//! Based on the SYSCLK frequency used and the baud rate chosen, the CiNBTCFG regsiter values are configured.
//!```
//!# use mcp2517::config::{BitRateConfig,CanBaudRate,SysClk};
//!
//!#
//! let bit_rate_config = BitRateConfig{
//! sys_clk: SysClk::MHz20,
//! can_speed: CanBaudRate::Kpbs500
Expand Down
2 changes: 1 addition & 1 deletion src/filter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
//! ```
//!# use mcp2517::filter::Filter;
//!# use embedded_can::{Id,ExtendedId};
//!
//!#
//! // ID to match
//! let id = Id::Extended(ExtendedId::new(0xC672).unwrap());
//! // Create filter with index 2
Expand Down
4 changes: 2 additions & 2 deletions src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//!# use bytes::Bytes;
//!# use mcp2517::message::{Can20,TxMessage};
//!# use embedded_can::{Id,StandardId};
//!
//!#
//! // Frame ID
//! let message_id = Id::Standard(StandardId::new(0x123).unwrap());
//! // Set message type to CAN2.0 with a maximum of 4 data bytes
Expand All @@ -26,7 +26,7 @@
//!# use bytes::Bytes;
//!# use mcp2517::message::{CanFd,TxMessage};
//!# use embedded_can::{Id,StandardId};
//!
//!#
//! // Frame ID
//! let message_id = Id::Standard(StandardId::new(0x123).unwrap());
//! // Set message type to CANfd with a max of 24 data bytes with bit rate switch enabled
Expand Down

0 comments on commit 0b95c28

Please sign in to comment.