Skip to content

Commit ebd48c6

Browse files
rusty1968FerralCoder
authored andcommitted
docs: fix unclosed HTML tags in rustdoc comments
Add backticks around type references to prevent rustdoc from interpreting them as HTML tags: - `Option<u8>` instead of Option<u8> - `Option<enum>` instead of Option<enum> This eliminates the rustdoc warnings: - warning: unclosed HTML tag `u8` - warning: unclosed HTML tag `enum` The type references are now properly formatted as code in the generated documentation.
1 parent 7d3ef83 commit ebd48c6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

platform/impls/baremetal/mock/src/i2c_hardware.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ pub struct MockI2cHardware {
328328
// Slave mode fields
329329
/// Whether slave mode is currently enabled (1 byte)
330330
slave_enabled: bool,
331-
/// Currently configured slave address (1 byte: Option<u8>)
331+
/// Currently configured slave address (1 byte: `Option<u8>`)
332332
slave_address: Option<SevenBitAddress>,
333333
/// Slave receive buffer (64 bytes) - realistic I2C message size
334334
slave_rx_buffer: [u8; 64],
@@ -338,7 +338,7 @@ pub struct MockI2cHardware {
338338
slave_tx_buffer: [u8; 64],
339339
/// Number of valid bytes in transmit buffer (8 bytes: usize on 64-bit)
340340
slave_tx_count: usize,
341-
/// Most recent slave event that occurred (1 byte: Option<enum>)
341+
/// Most recent slave event that occurred (1 byte: `Option<enum>`)
342342
last_slave_event: Option<openprot_hal_blocking::i2c_hardware::slave::I2cSEvent>,
343343
}
344344

0 commit comments

Comments
 (0)