improve doc comments

This commit is contained in:
Vinzenz Schroeter 2024-08-29 22:02:53 +02:00
parent e0d5eff494
commit c9c51dcdc2
3 changed files with 13 additions and 36 deletions

View file

@ -8,7 +8,7 @@ use servicepoint::bitvec::prelude::{BitVec, Msb0};
/// cbindgen:no-export
type SpBitVec = BitVec<u8, Msb0>;
/// Opaque struct needed for correct code generation.
/// A vector of bits
#[derive(Clone)]
pub struct CBitVec {
actual: SpBitVec,

View file

@ -12,7 +12,11 @@ use crate::bit_vec::CBitVec;
use crate::brightness_grid::CBrightnessGrid;
use crate::cp437_grid::CCp437Grid;
/// Opaque struct needed for correct code generation.
/// A low-level display command.
///
/// This struct and associated functions implement the UDP protocol for the display.
///
/// To send a `CCommand`, use a `Connection`.
pub struct CCommand(pub(crate) Command);
impl Clone for CCommand {