vinzenz/servicepoint
0
0
Fork 0
mirror of https://github.com/cccb/servicepoint.git synced 2025-01-18 10:00:14 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix broken links in documentation

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-11-12 22:11:45 +01:00
parent 7fbfb9370e
commit 0ca1b67cb6
8 changed files with 49 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -97,7 +97,7 @@ mod feature_cp437 {
/// ///
/// See <https://en.wikipedia.org/wiki/Code_page_437#Character_set> /// See <https://en.wikipedia.org/wiki/Code_page_437#Character_set>
/// ///
/// Mostly copied from https://github.com/kip93/cp437-tools. License: GPL-3.0 /// Mostly copied from <https://github.com/kip93/cp437-tools>. License: GPL-3.0
#[rustfmt::skip] #[rustfmt::skip]
pub const CP437_TO_UTF8: [char; 256] = [ pub const CP437_TO_UTF8: [char; 256] = [
/* 0X */ '\0', '☺', '☻', '♥', '♦', '♣', '♠', '•', '◘', '○', '\n', '♂', '♀', '♪', '♫', '☼', /* 0X */ '\0', '☺', '☻', '♥', '♦', '♣', '♠', '•', '◘', '○', '\n', '♂', '♀', '♪', '♫', '☼',

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

@ -147,6 +147,8 @@ impl<T: PrimitiveGridType> PrimitiveGrid<T> {
/// let grid: BrightnessGrid = grid.map(Brightness::saturating_from); /// let grid: BrightnessGrid = grid.map(Brightness::saturating_from);
/// let command = Command::CharBrightness(Origin::ZERO, grid); /// let command = Command::CharBrightness(Origin::ZERO, grid);
/// ``` /// ```
/// [Brightness]: [crate::Brightness]
/// [Command]: [crate::Command]
pub fn map<TConverted, F>(&self, f: F) -> PrimitiveGrid<TConverted> pub fn map<TConverted, F>(&self, f: F) -> PrimitiveGrid<TConverted>
where where
TConverted: PrimitiveGridType, TConverted: PrimitiveGridType,

2
crates/servicepoint_binding_c/src/bitmap.rs
View file

@ -124,6 +124,8 @@ pub unsafe extern "C" fn sp_bitmap_clone(
/// - `bitmap` points to a valid [SPBitmap] /// - `bitmap` points to a valid [SPBitmap]
/// - `bitmap` is not used concurrently or after bitmap call /// - `bitmap` is not used concurrently or after bitmap call
/// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_bitmap_free(bitmap: *mut SPBitmap) { pub unsafe extern "C" fn sp_bitmap_free(bitmap: *mut SPBitmap) {
assert!(!bitmap.is_null()); assert!(!bitmap.is_null());

2
crates/servicepoint_binding_c/src/bitvec.rs
View file

@ -123,6 +123,8 @@ pub unsafe extern "C" fn sp_bitvec_clone(
/// - `bit_vec` points to a valid [SPBitVec] /// - `bit_vec` points to a valid [SPBitVec]
/// - `bit_vec` is not used concurrently or after this call /// - `bit_vec` is not used concurrently or after this call
/// - `bit_vec` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `bit_vec` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_bitvec_free(bit_vec: *mut SPBitVec) { pub unsafe extern "C" fn sp_bitvec_free(bit_vec: *mut SPBitVec) {
assert!(!bit_vec.is_null()); assert!(!bit_vec.is_null());

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

@ -133,6 +133,8 @@ pub unsafe extern "C" fn sp_brightness_grid_clone(
/// - `brightness_grid` points to a valid [SPBrightnessGrid] /// - `brightness_grid` points to a valid [SPBrightnessGrid]
/// - `brightness_grid` is not used concurrently or after this call /// - `brightness_grid` is not used concurrently or after this call
/// - `brightness_grid` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `brightness_grid` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_brightness_grid_free( pub unsafe extern "C" fn sp_brightness_grid_free(
brightness_grid: *mut SPBrightnessGrid, brightness_grid: *mut SPBrightnessGrid,
@ -191,7 +193,7 @@ pub unsafe extern "C" fn sp_brightness_grid_get(
/// ///
/// The caller has to make sure that: /// The caller has to make sure that:
/// ///
/// - `brightness_grid` points to a valid [SPBitVec] /// - `brightness_grid` points to a valid [SPBrightnessGrid]
/// - `brightness_grid` is not written to or read from concurrently /// - `brightness_grid` is not written to or read from concurrently
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_brightness_grid_set( pub unsafe extern "C" fn sp_brightness_grid_set(

24
crates/servicepoint_binding_c/src/command.rs
View file

@ -23,6 +23,8 @@ use crate::{
/// sp_connection_send_command(connection, sp_command_clear()); /// sp_connection_send_command(connection, sp_command_clear());
/// sp_connection_send_command(connection, sp_command_brightness(5)); /// sp_connection_send_command(connection, sp_command_brightness(5));
/// ``` /// ```
///
/// [SPConnection]: [crate::SPConnection]
pub struct SPCommand(pub(crate) servicepoint::Command); pub struct SPCommand(pub(crate) servicepoint::Command);
impl Clone for SPCommand { impl Clone for SPCommand {
@ -90,7 +92,7 @@ pub unsafe extern "C" fn sp_command_clone(
/// ///
/// Does not affect brightness. /// Does not affect brightness.
/// ///
/// Returns: a new [Command::Clear] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Clear] instance. Will never return NULL.
/// ///
/// # Examples /// # Examples
/// ///
@ -114,7 +116,7 @@ pub unsafe extern "C" fn sp_command_clear() -> NonNull<SPCommand> {
/// ///
/// Please do not send this in your normal program flow. /// Please do not send this in your normal program flow.
/// ///
/// Returns: a new [Command::HardReset] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::HardReset] instance. Will never return NULL.
/// ///
/// # Safety /// # Safety
/// ///
@ -130,7 +132,7 @@ pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull<SPCommand> {
/// A yet-to-be-tested command. /// A yet-to-be-tested command.
/// ///
/// Returns: a new `Command::FadeOut` instance. Will never return NULL. /// Returns: a new [servicepoint::Command::FadeOut] instance. Will never return NULL.
/// ///
/// # Safety /// # Safety
/// ///
@ -146,7 +148,7 @@ pub unsafe extern "C" fn sp_command_fade_out() -> NonNull<SPCommand> {
/// Set the brightness of all tiles to the same value. /// Set the brightness of all tiles to the same value.
/// ///
/// Returns: a new [Command::Brightness] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Brightness] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -174,7 +176,7 @@ pub unsafe extern "C" fn sp_command_brightness(
/// ///
/// The passed [SPBrightnessGrid] gets consumed. /// The passed [SPBrightnessGrid] gets consumed.
/// ///
/// Returns: a new [Command::CharBrightness] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::CharBrightness] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -211,7 +213,7 @@ pub unsafe extern "C" fn sp_command_char_brightness(
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinear] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinear] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -254,7 +256,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear(
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearAnd] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearAnd] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -297,7 +299,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_and(
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearOr] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearOr] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -340,7 +342,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_or(
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearXor] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearXor] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -378,7 +380,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_xor(
/// ///
/// The passed [SPCp437Grid] gets consumed. /// The passed [SPCp437Grid] gets consumed.
/// ///
/// Returns: a new [Command::Cp437Data] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Cp437Data] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -410,7 +412,7 @@ pub unsafe extern "C" fn sp_command_cp437_data(
/// ///
/// The passed [SPBitmap] gets consumed. /// The passed [SPBitmap] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearWin] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearWin] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///

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

@ -117,6 +117,8 @@ pub unsafe extern "C" fn sp_cp437_grid_clone(
/// - `cp437_grid` points to a valid [SPCp437Grid] /// - `cp437_grid` points to a valid [SPCp437Grid]
/// - `cp437_grid` is not used concurrently or after cp437_grid call /// - `cp437_grid` is not used concurrently or after cp437_grid call
/// - `cp437_grid` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `cp437_grid` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: *mut SPCp437Grid) { pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: *mut SPCp437Grid) {
assert!(!cp437_grid.is_null()); assert!(!cp437_grid.is_null());
@ -172,6 +174,8 @@ pub unsafe extern "C" fn sp_cp437_grid_get(
/// ///
/// - `cp437_grid` points to a valid [SPBitVec] /// - `cp437_grid` points to a valid [SPBitVec]
/// - `cp437_grid` is not written to or read from concurrently /// - `cp437_grid` is not written to or read from concurrently
///
/// [SPBitVec]: [crate::SPBitVec]
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn sp_cp437_grid_set( pub unsafe extern "C" fn sp_cp437_grid_set(
cp437_grid: *mut SPCp437Grid, cp437_grid: *mut SPCp437Grid,

34
crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs
View file

@ -108,6 +108,8 @@ namespace ServicePoint.BindGen
/// - `bitmap` points to a valid [SPBitmap] /// - `bitmap` points to a valid [SPBitmap]
/// - `bitmap` is not used concurrently or after bitmap call /// - `bitmap` is not used concurrently or after bitmap call
/// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_bitmap_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_bitmap_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
public static extern void sp_bitmap_free(Bitmap* bitmap); public static extern void sp_bitmap_free(Bitmap* bitmap);
@ -321,6 +323,8 @@ namespace ServicePoint.BindGen
/// - `bit_vec` points to a valid [SPBitVec] /// - `bit_vec` points to a valid [SPBitVec]
/// - `bit_vec` is not used concurrently or after this call /// - `bit_vec` is not used concurrently or after this call
/// - `bit_vec` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `bit_vec` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_bitvec_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_bitvec_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
public static extern void sp_bitvec_free(BitVec* bit_vec); public static extern void sp_bitvec_free(BitVec* bit_vec);
@ -540,6 +544,8 @@ namespace ServicePoint.BindGen
/// - `brightness_grid` points to a valid [SPBrightnessGrid] /// - `brightness_grid` points to a valid [SPBrightnessGrid]
/// - `brightness_grid` is not used concurrently or after this call /// - `brightness_grid` is not used concurrently or after this call
/// - `brightness_grid` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `brightness_grid` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_brightness_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_brightness_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
public static extern void sp_brightness_grid_free(BrightnessGrid* brightness_grid); public static extern void sp_brightness_grid_free(BrightnessGrid* brightness_grid);
@ -590,7 +596,7 @@ namespace ServicePoint.BindGen
/// ///
/// The caller has to make sure that: /// The caller has to make sure that:
/// ///
/// - `brightness_grid` points to a valid [SPBitVec] /// - `brightness_grid` points to a valid [SPBrightnessGrid]
/// - `brightness_grid` is not written to or read from concurrently /// - `brightness_grid` is not written to or read from concurrently
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_brightness_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_brightness_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
@ -737,7 +743,7 @@ namespace ServicePoint.BindGen
/// ///
/// Does not affect brightness. /// Does not affect brightness.
/// ///
/// Returns: a new [Command::Clear] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Clear] instance. Will never return NULL.
/// ///
/// # Examples /// # Examples
/// ///
@ -760,7 +766,7 @@ namespace ServicePoint.BindGen
/// ///
/// Please do not send this in your normal program flow. /// Please do not send this in your normal program flow.
/// ///
/// Returns: a new [Command::HardReset] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::HardReset] instance. Will never return NULL.
/// ///
/// # Safety /// # Safety
/// ///
@ -775,7 +781,7 @@ namespace ServicePoint.BindGen
/// <summary> /// <summary>
/// A yet-to-be-tested command. /// A yet-to-be-tested command.
/// ///
/// Returns: a new `Command::FadeOut` instance. Will never return NULL. /// Returns: a new [servicepoint::Command::FadeOut] instance. Will never return NULL.
/// ///
/// # Safety /// # Safety
/// ///
@ -790,7 +796,7 @@ namespace ServicePoint.BindGen
/// <summary> /// <summary>
/// Set the brightness of all tiles to the same value. /// Set the brightness of all tiles to the same value.
/// ///
/// Returns: a new [Command::Brightness] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Brightness] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -811,7 +817,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBrightnessGrid] gets consumed. /// The passed [SPBrightnessGrid] gets consumed.
/// ///
/// Returns: a new [Command::CharBrightness] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::CharBrightness] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -839,7 +845,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinear] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinear] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -869,7 +875,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearAnd] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearAnd] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -899,7 +905,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearOr] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearOr] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -929,7 +935,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBitVec] gets consumed. /// The passed [SPBitVec] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearXor] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearXor] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -954,7 +960,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPCp437Grid] gets consumed. /// The passed [SPCp437Grid] gets consumed.
/// ///
/// Returns: a new [Command::Cp437Data] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::Cp437Data] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -977,7 +983,7 @@ namespace ServicePoint.BindGen
/// ///
/// The passed [SPBitmap] gets consumed. /// The passed [SPBitmap] gets consumed.
/// ///
/// Returns: a new [Command::BitmapLinearWin] instance. Will never return NULL. /// Returns: a new [servicepoint::Command::BitmapLinearWin] instance. Will never return NULL.
/// ///
/// # Panics /// # Panics
/// ///
@ -1178,6 +1184,8 @@ namespace ServicePoint.BindGen
/// - `cp437_grid` points to a valid [SPCp437Grid] /// - `cp437_grid` points to a valid [SPCp437Grid]
/// - `cp437_grid` is not used concurrently or after cp437_grid call /// - `cp437_grid` is not used concurrently or after cp437_grid call
/// - `cp437_grid` was not passed to another consuming function, e.g. to create a [SPCommand] /// - `cp437_grid` was not passed to another consuming function, e.g. to create a [SPCommand]
///
/// [SPCommand]: [crate::SPCommand]
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_cp437_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_cp437_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
public static extern void sp_cp437_grid_free(Cp437Grid* cp437_grid); public static extern void sp_cp437_grid_free(Cp437Grid* cp437_grid);
@ -1227,6 +1235,8 @@ namespace ServicePoint.BindGen
/// ///
/// - `cp437_grid` points to a valid [SPBitVec] /// - `cp437_grid` points to a valid [SPBitVec]
/// - `cp437_grid` is not written to or read from concurrently /// - `cp437_grid` is not written to or read from concurrently
///
/// [SPBitVec]: [crate::SPBitVec]
/// </summary> /// </summary>
[DllImport(__DllName, EntryPoint = "sp_cp437_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [DllImport(__DllName, EntryPoint = "sp_cp437_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)]
public static extern void sp_cp437_grid_set(Cp437Grid* cp437_grid, nuint x, nuint y, byte value); public static extern void sp_cp437_grid_set(Cp437Grid* cp437_grid, nuint x, nuint y, byte value);