servicepoint/servicepoint-binding-c
0
2
Fork 0
Code Issues 1 Pull requests 1 Projects Releases 2 Packages Wiki Activity Actions

replace * with - for bullets in comments

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-08-29 19:39:18 +02:00
parent 5cb135c7e9
commit 14faeb1238
10 changed files with 211 additions and 127 deletions
Download patch file Download diff file Expand all files Collapse all files

2
crates/servicepoint/src/connection.rs
View file

@ -44,7 +44,7 @@ impl Connection {
///
/// # Arguments
///
/// * `packet`: the packet-like to send
/// - `packet`: the packet-like to send
///
/// returns: Ok if packet was sent, otherwise socket error
///

8
crates/servicepoint/src/grid.rs
View file

@ -4,7 +4,7 @@ pub trait Grid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell to read
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///
@ -15,7 +15,7 @@ pub trait Grid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell to read
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///
@ -26,7 +26,7 @@ pub trait Grid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell to read
/// - `x` and `y`: position of the cell to read
///
/// returns: Value at position or None
fn get_optional(&self, x: isize, y: isize) -> Option<T> {
@ -41,7 +41,7 @@ pub trait Grid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell to read
/// - `x` and `y`: position of the cell to read
///
/// returns: the old value or None
fn set_optional(&mut self, x: isize, y: isize, value: T) -> bool {

16
crates/servicepoint/src/pixel_grid.rs
View file

@ -17,8 +17,8 @@ impl PixelGrid {
///
/// # Arguments
///
/// * `width`: size in pixels in x-direction
/// * `height`: size in pixels in y-direction
/// - `width`: size in pixels in x-direction
/// - `height`: size in pixels in y-direction
///
/// returns: `PixelGrid` initialized to all pixels off
///
@ -44,8 +44,8 @@ impl PixelGrid {
///
/// # Arguments
///
/// * `width`: size in pixels in x-direction
/// * `height`: size in pixels in y-direction
/// - `width`: size in pixels in x-direction
/// - `height`: size in pixels in y-direction
///
/// returns: `PixelGrid` that contains a copy of the provided data
///
@ -121,8 +121,8 @@ impl Grid<bool> for PixelGrid {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell
/// * `value`: the value to write to the cell
/// - `x` and `y`: position of the cell
/// - `value`: the value to write to the cell
///
/// returns: old value of the cell
///
@ -143,8 +143,8 @@ impl Grid<bool> for PixelGrid {
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `value`: the value to set all pixels to
/// - `this`: instance to write to
/// - `value`: the value to set all pixels to
fn fill(&mut self, value: bool) {
self.bit_vec.fill(value);
}

10
crates/servicepoint/src/primitive_grid.rs
View file

@ -82,7 +82,7 @@ impl<T: PrimitiveGridType> PrimitiveGrid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell
/// - `x` and `y`: position of the cell
///
/// # Panics
///
@ -96,7 +96,7 @@ impl<T: PrimitiveGridType> PrimitiveGrid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell
/// - `x` and `y`: position of the cell
///
/// returns: Reference to cell or None
pub fn get_ref_mut_optional(
@ -117,8 +117,8 @@ impl<T: PrimitiveGridType> Grid<T> for PrimitiveGrid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell
/// * `value`: the value to write to the cell
/// - `x` and `y`: position of the cell
/// - `value`: the value to write to the cell
///
/// # Panics
///
@ -132,7 +132,7 @@ impl<T: PrimitiveGridType> Grid<T> for PrimitiveGrid<T> {
///
/// # Arguments
///
/// * `x` and `y`: position of the cell to read
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///