servicepoint/servicepoint-binding-csharp
0
0
Fork 0
Code Issues Pull requests 1 Projects Releases 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

14
crates/servicepoint_binding_c/src/bit_vec.rs
View file

@ -30,7 +30,7 @@ impl From<CBitVec> for SpBitVec {
///
/// # Arguments
///
/// * `size`: size in bits.
/// - `size`: size in bits.
///
/// returns: `BitVec` with all bits set to false.
///
@ -107,8 +107,8 @@ pub unsafe extern "C" fn sp_bit_vec_dealloc(this: *mut CBitVec) {
///
/// # Arguments
///
/// * `this`: instance to read from
/// * `index`: the bit index to read
/// - `this`: instance to read from
/// - `index`: the bit index to read
///
/// returns: value of the bit
///
@ -134,9 +134,9 @@ pub unsafe extern "C" fn sp_bit_vec_get(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `index`: the bit index to edit
/// * `value`: the value to set the bit to
/// - `this`: instance to write to
/// - `index`: the bit index to edit
/// - `value`: the value to set the bit to
///
/// returns: old value of the bit
///
@ -163,7 +163,7 @@ pub unsafe extern "C" fn sp_bit_vec_set(
///
/// # Arguments
///
/// * `value`: the value to set all bits to
/// - `value`: the value to set all bits to
///
/// # Safety
///

25
crates/servicepoint_binding_c/src/brightness_grid.rs
View file

@ -96,8 +96,8 @@ pub unsafe extern "C" fn sp_brightness_grid_dealloc(
///
/// # Arguments
///
/// * `this`: instance to read from
/// * `x` and `y`: position of the cell to read
/// - `this`: instance to read from
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///
@ -122,15 +122,16 @@ pub unsafe extern "C" fn sp_brightness_grid_get(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `x` and `y`: position of the cell
/// * `value`: the value to write to the cell
/// - `this`: instance to write to
/// - `x` and `y`: position of the cell
/// - `value`: the value to write to the cell
///
/// returns: old value of the cell
///
/// # Panics
///
/// When accessing `x` or `y` out of bounds.
/// - When accessing `x` or `y` out of bounds.
/// - When providing an invalid brightness value
///
/// # Safety
///
@ -154,8 +155,12 @@ pub unsafe extern "C" fn sp_brightness_grid_set(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `value`: the value to set all cells to
/// - `this`: instance to write to
/// - `value`: the value to set all cells to
///
/// # Panics
///
/// - When providing an invalid brightness value
///
/// # Safety
///
@ -177,7 +182,7 @@ pub unsafe extern "C" fn sp_brightness_grid_fill(
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///
@ -195,7 +200,7 @@ pub unsafe extern "C" fn sp_brightness_grid_width(
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///

18
crates/servicepoint_binding_c/src/cp437_grid.rs
View file

@ -90,8 +90,8 @@ pub unsafe extern "C" fn sp_cp437_grid_dealloc(this: *mut CCp437Grid) {
///
/// # Arguments
///
/// * `this`: instance to read from
/// * `x` and `y`: position of the cell to read
/// - `this`: instance to read from
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///
@ -116,9 +116,9 @@ pub unsafe extern "C" fn sp_cp437_grid_get(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `x` and `y`: position of the cell
/// * `value`: the value to write to the cell
/// - `this`: instance to write to
/// - `x` and `y`: position of the cell
/// - `value`: the value to write to the cell
///
/// returns: old value of the cell
///
@ -146,8 +146,8 @@ pub unsafe extern "C" fn sp_cp437_grid_set(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `value`: the value to set all cells to
/// - `this`: instance to write to
/// - `value`: the value to set all cells to
///
/// # Safety
///
@ -164,7 +164,7 @@ pub unsafe extern "C" fn sp_cp437_grid_fill(this: *mut CCp437Grid, value: u8) {
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///
@ -180,7 +180,7 @@ pub unsafe extern "C" fn sp_cp437_grid_width(this: *const CCp437Grid) -> usize {
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///

26
crates/servicepoint_binding_c/src/pixel_grid.rs
View file

@ -10,8 +10,8 @@ use crate::c_slice::CByteSlice;
///
/// # 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
///
@ -37,8 +37,8 @@ pub unsafe extern "C" fn sp_pixel_grid_new(
///
/// # 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
///
@ -100,8 +100,8 @@ pub unsafe extern "C" fn sp_pixel_grid_dealloc(this: *mut PixelGrid) {
///
/// # Arguments
///
/// * `this`: instance to read from
/// * `x` and `y`: position of the cell to read
/// - `this`: instance to read from
/// - `x` and `y`: position of the cell to read
///
/// # Panics
///
@ -126,9 +126,9 @@ pub unsafe extern "C" fn sp_pixel_grid_get(
///
/// # Arguments
///
/// * `this`: instance to write to
/// * `x` and `y`: position of the cell
/// * `value`: the value to write to the cell
/// - `this`: instance to write to
/// - `x` and `y`: position of the cell
/// - `value`: the value to write to the cell
///
/// returns: old value of the cell
///
@ -156,8 +156,8 @@ pub unsafe extern "C" fn sp_pixel_grid_set(
///
/// # 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
///
/// # Safety
///
@ -174,7 +174,7 @@ pub unsafe extern "C" fn sp_pixel_grid_fill(this: *mut PixelGrid, value: bool) {
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///
@ -190,7 +190,7 @@ pub unsafe extern "C" fn sp_pixel_grid_width(this: *const PixelGrid) -> usize {
///
/// # Arguments
///
/// * `this`: instance to read from
/// - `this`: instance to read from
///
/// # Safety
///