From 0ca1b67cb6c0bbf68c8d0a7d3add640c63edcdb8 Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Tue, 12 Nov 2024 22:11:45 +0100 Subject: [PATCH] fix broken links in documentation --- crates/servicepoint/src/cp437.rs | 2 +- crates/servicepoint/src/primitive_grid.rs | 2 ++ crates/servicepoint_binding_c/src/bitmap.rs | 2 ++ crates/servicepoint_binding_c/src/bitvec.rs | 2 ++ .../src/brightness_grid.rs | 4 ++- crates/servicepoint_binding_c/src/command.rs | 24 +++++++------ .../servicepoint_binding_c/src/cp437_grid.rs | 4 +++ .../ServicePoint/BindGen/ServicePoint.g.cs | 34 ++++++++++++------- 8 files changed, 49 insertions(+), 25 deletions(-) diff --git a/crates/servicepoint/src/cp437.rs b/crates/servicepoint/src/cp437.rs index 9a81717..194e3f6 100644 --- a/crates/servicepoint/src/cp437.rs +++ b/crates/servicepoint/src/cp437.rs @@ -97,7 +97,7 @@ mod feature_cp437 { /// /// See /// - /// Mostly copied from https://github.com/kip93/cp437-tools. License: GPL-3.0 + /// Mostly copied from . License: GPL-3.0 #[rustfmt::skip] pub const CP437_TO_UTF8: [char; 256] = [ /* 0X */ '\0', '☺', '☻', '♥', '♦', '♣', '♠', '•', '◘', '○', '\n', '♂', '♀', '♪', '♫', '☼', diff --git a/crates/servicepoint/src/primitive_grid.rs b/crates/servicepoint/src/primitive_grid.rs index 882a1a5..366f0ca 100644 --- a/crates/servicepoint/src/primitive_grid.rs +++ b/crates/servicepoint/src/primitive_grid.rs @@ -147,6 +147,8 @@ impl PrimitiveGrid { /// let grid: BrightnessGrid = grid.map(Brightness::saturating_from); /// let command = Command::CharBrightness(Origin::ZERO, grid); /// ``` + /// [Brightness]: [crate::Brightness] + /// [Command]: [crate::Command] pub fn map(&self, f: F) -> PrimitiveGrid where TConverted: PrimitiveGridType, diff --git a/crates/servicepoint_binding_c/src/bitmap.rs b/crates/servicepoint_binding_c/src/bitmap.rs index b327fd2..a7ae48a 100644 --- a/crates/servicepoint_binding_c/src/bitmap.rs +++ b/crates/servicepoint_binding_c/src/bitmap.rs @@ -124,6 +124,8 @@ pub unsafe extern "C" fn sp_bitmap_clone( /// - `bitmap` points to a valid [SPBitmap] /// - `bitmap` is not used concurrently or after bitmap call /// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] +/// +/// [SPCommand]: [crate::SPCommand] #[no_mangle] pub unsafe extern "C" fn sp_bitmap_free(bitmap: *mut SPBitmap) { assert!(!bitmap.is_null()); diff --git a/crates/servicepoint_binding_c/src/bitvec.rs b/crates/servicepoint_binding_c/src/bitvec.rs index 7f2258a..4ee5f52 100644 --- a/crates/servicepoint_binding_c/src/bitvec.rs +++ b/crates/servicepoint_binding_c/src/bitvec.rs @@ -123,6 +123,8 @@ pub unsafe extern "C" fn sp_bitvec_clone( /// - `bit_vec` points to a valid [SPBitVec] /// - `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] +/// +/// [SPCommand]: [crate::SPCommand] #[no_mangle] pub unsafe extern "C" fn sp_bitvec_free(bit_vec: *mut SPBitVec) { assert!(!bit_vec.is_null()); diff --git a/crates/servicepoint_binding_c/src/brightness_grid.rs b/crates/servicepoint_binding_c/src/brightness_grid.rs index 3c94b57..04187d7 100644 --- a/crates/servicepoint_binding_c/src/brightness_grid.rs +++ b/crates/servicepoint_binding_c/src/brightness_grid.rs @@ -133,6 +133,8 @@ pub unsafe extern "C" fn sp_brightness_grid_clone( /// - `brightness_grid` points to a valid [SPBrightnessGrid] /// - `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] +/// +/// [SPCommand]: [crate::SPCommand] #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_free( brightness_grid: *mut SPBrightnessGrid, @@ -191,7 +193,7 @@ pub unsafe extern "C" fn sp_brightness_grid_get( /// /// 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 #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_set( diff --git a/crates/servicepoint_binding_c/src/command.rs b/crates/servicepoint_binding_c/src/command.rs index a4ebc1a..1c56d07 100644 --- a/crates/servicepoint_binding_c/src/command.rs +++ b/crates/servicepoint_binding_c/src/command.rs @@ -23,6 +23,8 @@ use crate::{ /// sp_connection_send_command(connection, sp_command_clear()); /// sp_connection_send_command(connection, sp_command_brightness(5)); /// ``` +/// +/// [SPConnection]: [crate::SPConnection] pub struct SPCommand(pub(crate) servicepoint::Command); impl Clone for SPCommand { @@ -90,7 +92,7 @@ pub unsafe extern "C" fn sp_command_clone( /// /// 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 /// @@ -114,7 +116,7 @@ pub unsafe extern "C" fn sp_command_clear() -> NonNull { /// /// 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 /// @@ -130,7 +132,7 @@ pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull { /// 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 /// @@ -146,7 +148,7 @@ pub unsafe extern "C" fn sp_command_fade_out() -> NonNull { /// 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 /// @@ -174,7 +176,7 @@ pub unsafe extern "C" fn sp_command_brightness( /// /// 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 /// @@ -211,7 +213,7 @@ pub unsafe extern "C" fn sp_command_char_brightness( /// /// 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 /// @@ -254,7 +256,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear( /// /// 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 /// @@ -297,7 +299,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_and( /// /// 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 /// @@ -340,7 +342,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_or( /// /// 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 /// @@ -378,7 +380,7 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_xor( /// /// 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 /// @@ -410,7 +412,7 @@ pub unsafe extern "C" fn sp_command_cp437_data( /// /// 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 /// diff --git a/crates/servicepoint_binding_c/src/cp437_grid.rs b/crates/servicepoint_binding_c/src/cp437_grid.rs index b940ae4..32e2642 100644 --- a/crates/servicepoint_binding_c/src/cp437_grid.rs +++ b/crates/servicepoint_binding_c/src/cp437_grid.rs @@ -117,6 +117,8 @@ pub unsafe extern "C" fn sp_cp437_grid_clone( /// - `cp437_grid` points to a valid [SPCp437Grid] /// - `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] +/// +/// [SPCommand]: [crate::SPCommand] #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: *mut SPCp437Grid) { 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` is not written to or read from concurrently +/// +/// [SPBitVec]: [crate::SPBitVec] #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_set( cp437_grid: *mut SPCp437Grid, diff --git a/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs b/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs index c8bb0a2..8f41ab4 100644 --- a/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs +++ b/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs @@ -108,6 +108,8 @@ namespace ServicePoint.BindGen /// - `bitmap` points to a valid [SPBitmap] /// - `bitmap` is not used concurrently or after bitmap call /// - `bitmap` was not passed to another consuming function, e.g. to create a [SPCommand] + /// + /// [SPCommand]: [crate::SPCommand] /// [DllImport(__DllName, EntryPoint = "sp_bitmap_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] 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` is not used concurrently or after this call /// - `bit_vec` was not passed to another consuming function, e.g. to create a [SPCommand] + /// + /// [SPCommand]: [crate::SPCommand] /// [DllImport(__DllName, EntryPoint = "sp_bitvec_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] 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` is not used concurrently or after this call /// - `brightness_grid` was not passed to another consuming function, e.g. to create a [SPCommand] + /// + /// [SPCommand]: [crate::SPCommand] /// [DllImport(__DllName, EntryPoint = "sp_brightness_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] 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: /// - /// - `brightness_grid` points to a valid [SPBitVec] + /// - `brightness_grid` points to a valid [SPBrightnessGrid] /// - `brightness_grid` is not written to or read from concurrently /// [DllImport(__DllName, EntryPoint = "sp_brightness_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] @@ -737,7 +743,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -760,7 +766,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -775,7 +781,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -790,7 +796,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -811,7 +817,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -839,7 +845,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -869,7 +875,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -899,7 +905,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -929,7 +935,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -954,7 +960,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -977,7 +983,7 @@ namespace ServicePoint.BindGen /// /// 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 /// @@ -1178,6 +1184,8 @@ namespace ServicePoint.BindGen /// - `cp437_grid` points to a valid [SPCp437Grid] /// - `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] + /// + /// [SPCommand]: [crate::SPCommand] /// [DllImport(__DllName, EntryPoint = "sp_cp437_grid_free", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] 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` is not written to or read from concurrently + /// + /// [SPBitVec]: [crate::SPBitVec] /// [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);