From c702d832f4e51715b880cb0eaa104e4b78206191 Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Sat, 28 Jun 2025 17:21:00 +0200 Subject: [PATCH] do not link non existant functions in the base library --- include/servicepoint.h | 150 ----------------------------------------- src/commands/mod.rs | 2 + src/macros.rs | 8 +-- 3 files changed, 5 insertions(+), 155 deletions(-) diff --git a/include/servicepoint.h b/include/servicepoint.h index 703ab37..bb825c7 100644 --- a/include/servicepoint.h +++ b/include/servicepoint.h @@ -669,8 +669,6 @@ struct ByteSlice sp_bitmap_data_ref_mut(struct Bitmap */*notnull*/ instance); void sp_bitmap_fill(struct Bitmap */*notnull*/ instance, bool value); /** - * Calls method [`servicepoint::Bitmap::free`]. - * *Deallocates a [`Bitmap`] instance. * * This function is part of the `bitmap` module. @@ -716,8 +714,6 @@ bool sp_bitmap_get(struct Bitmap */*notnull*/ instance, size_t x, size_t y); size_t sp_bitmap_height(struct Bitmap */*notnull*/ instance); /** - * Calls method [`servicepoint::Bitmap::into_bitvec`]. - * * Consumes the Bitmap and returns the contained BitVec. * * This function is part of the `bitmap` module. @@ -800,8 +796,6 @@ void sp_bitmap_set(struct Bitmap */*notnull*/ instance, bool value); /** - * Calls method [`servicepoint::Bitmap::try_into_packet`]. - * * Creates a [BitmapCommand] and immediately turns that into a [Packet]. * * The provided [Bitmap] gets consumed. @@ -834,8 +828,6 @@ size_t sp_bitmap_width(struct Bitmap */*notnull*/ instance); struct BitmapCommand */*notnull*/ sp_bitmapcommand_clone(struct BitmapCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitmapCommand::free`]. - * *Deallocates a [`BitmapCommand`] instance. * * This function is part of the `bitmapcommand` module. @@ -853,8 +845,6 @@ void sp_bitmapcommand_free(struct BitmapCommand */*notnull*/ instance); struct BitmapCommand */*notnull*/ sp_bitmapcommand_from_bitmap(struct Bitmap */*notnull*/ bitmap); /** - * Calls method [`servicepoint::BitmapCommand::get_bitmap_mut`]. - * * Gets a reference to the field `bitmap` of the [`servicepoint::BitmapCommand`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -865,8 +855,6 @@ struct BitmapCommand */*notnull*/ sp_bitmapcommand_from_bitmap(struct Bitmap */* struct Bitmap */*notnull*/ sp_bitmapcommand_get_bitmap_mut(struct BitmapCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitmapCommand::get_compression`]. - * * Gets the value of field `compression` of the [`servicepoint::BitmapCommand`]. * * This function is part of the `bitmapcommand` module. @@ -874,8 +862,6 @@ struct Bitmap */*notnull*/ sp_bitmapcommand_get_bitmap_mut(struct BitmapCommand CompressionCode sp_bitmapcommand_get_compression(struct BitmapCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitmapCommand::get_origin`]. - * * Reads the origin field of the [`BitmapCommand`]. * * This function is part of the `bitmapcommand` module. @@ -899,8 +885,6 @@ struct BitmapCommand */*notnull*/ sp_bitmapcommand_new(struct Bitmap */*notnull* CompressionCode compression); /** - * Calls method [`servicepoint::BitmapCommand::set_bitmap`]. - * * Sets the value of field `bitmap` of the [`servicepoint::BitmapCommand`]. * The provided value is moved into the instance, potentially invalidating previously taken references. * @@ -910,8 +894,6 @@ void sp_bitmapcommand_set_bitmap(struct BitmapCommand */*notnull*/ instance, struct Bitmap */*notnull*/ value); /** - * Calls method [`servicepoint::BitmapCommand::set_compression`]. - * * Sets the value of field `compression` of the [`servicepoint::BitmapCommand`]. * * This function is part of the `bitmapcommand` module. @@ -920,8 +902,6 @@ void sp_bitmapcommand_set_compression(struct BitmapCommand */*notnull*/ instance CompressionCode value); /** - * Calls method [`servicepoint::BitmapCommand::set_origin`]. - * * Overwrites the origin field of the [`BitmapCommand`]. * * This function is part of the `bitmapcommand` module. @@ -931,8 +911,6 @@ void sp_bitmapcommand_set_origin(struct BitmapCommand */*notnull*/ command, size_t origin_y); /** - * Calls method [`servicepoint::BitmapCommand::try_into_packet`]. - * *Tries to turn a [`BitmapCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -951,8 +929,6 @@ struct Packet *sp_bitmapcommand_try_into_packet(struct BitmapCommand */*notnull* struct BitVecCommand */*notnull*/ sp_bitveccommand_clone(struct BitVecCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitVecCommand::free`]. - * *Deallocates a [`BitVecCommand`] instance. * * This function is part of the `bitveccommand` module. @@ -960,8 +936,6 @@ struct BitVecCommand */*notnull*/ sp_bitveccommand_clone(struct BitVecCommand */ void sp_bitveccommand_free(struct BitVecCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitVecCommand::get_bitvec_mut`]. - * * Gets a reference to the field `bitvec` of the [`servicepoint::BitVecCommand`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -972,8 +946,6 @@ void sp_bitveccommand_free(struct BitVecCommand */*notnull*/ instance); DisplayBitVec */*notnull*/ sp_bitveccommand_get_bitvec_mut(struct BitVecCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitVecCommand::get_compression`]. - * * Gets the value of field `compression` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -981,8 +953,6 @@ DisplayBitVec */*notnull*/ sp_bitveccommand_get_bitvec_mut(struct BitVecCommand CompressionCode sp_bitveccommand_get_compression(struct BitVecCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitVecCommand::get_offset`]. - * * Gets the value of field `offset` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -990,8 +960,6 @@ CompressionCode sp_bitveccommand_get_compression(struct BitVecCommand */*notnull Offset sp_bitveccommand_get_offset(struct BitVecCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BitVecCommand::get_operation`]. - * * Gets the value of field `operation` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -1020,8 +988,6 @@ struct BitVecCommand */*notnull*/ sp_bitveccommand_new(DisplayBitVec */*notnull* CompressionCode compression); /** - * Calls method [`servicepoint::BitVecCommand::set_bitvec`]. - * * Sets the value of field `bitvec` of the [`servicepoint::BitVecCommand`]. * The provided value is moved into the instance, potentially invalidating previously taken references. * @@ -1031,8 +997,6 @@ void sp_bitveccommand_set_bitvec(struct BitVecCommand */*notnull*/ instance, DisplayBitVec */*notnull*/ value); /** - * Calls method [`servicepoint::BitVecCommand::set_compression`]. - * * Sets the value of field `compression` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -1041,8 +1005,6 @@ void sp_bitveccommand_set_compression(struct BitVecCommand */*notnull*/ instance CompressionCode value); /** - * Calls method [`servicepoint::BitVecCommand::set_offset`]. - * * Sets the value of field `offset` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -1051,8 +1013,6 @@ void sp_bitveccommand_set_offset(struct BitVecCommand */*notnull*/ instance, Offset value); /** - * Calls method [`servicepoint::BitVecCommand::set_operation`]. - * * Sets the value of field `operation` of the [`servicepoint::BitVecCommand`]. * * This function is part of the `bitveccommand` module. @@ -1061,8 +1021,6 @@ void sp_bitveccommand_set_operation(struct BitVecCommand */*notnull*/ instance, BinaryOperation value); /** - * Calls method [`servicepoint::BitVecCommand::try_into_packet`]. - * *Tries to turn a [`BitVecCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -1081,8 +1039,6 @@ struct Packet *sp_bitveccommand_try_into_packet(struct BitVecCommand */*notnull* BrightnessGrid */*notnull*/ sp_brightnessgrid_clone(BrightnessGrid */*notnull*/ instance); /** - * Calls method [`servicepoint::BrightnessGrid::data_ref_mut`]. - * * Gets an unsafe reference to the data of the instance. * * The returned memory is valid for the lifetime of the grid. @@ -1106,8 +1062,6 @@ void sp_brightnessgrid_fill(BrightnessGrid */*notnull*/ instance, Brightness value); /** - * Calls method [`servicepoint::BrightnessGrid::free`]. - * *Deallocates a [`BrightnessGrid`] instance. * * This function is part of the `brightnessgrid` module. @@ -1200,8 +1154,6 @@ void sp_brightnessgrid_set(BrightnessGrid */*notnull*/ instance, Brightness value); /** - * Calls method [`servicepoint::BrightnessGrid::try_into_packet`]. - * * Creates a [BrightnessGridCommand] and immediately turns that into a [Packet]. * * The provided [BrightnessGrid] gets consumed. @@ -1233,8 +1185,6 @@ size_t sp_brightnessgrid_width(BrightnessGrid */*notnull*/ instance); struct BrightnessGridCommand */*notnull*/ sp_brightnessgridcommand_clone(struct BrightnessGridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BrightnessGridCommand::free`]. - * *Deallocates a [`BrightnessGridCommand`] instance. * * This function is part of the `brightnessgridcommand` module. @@ -1250,8 +1200,6 @@ void sp_brightnessgridcommand_free(struct BrightnessGridCommand */*notnull*/ ins struct BrightnessGridCommand */*notnull*/ sp_brightnessgridcommand_from_grid(BrightnessGrid */*notnull*/ grid); /** - * Calls method [`servicepoint::BrightnessGridCommand::get_grid_mut`]. - * * Gets a reference to the field `grid` of the [`servicepoint::BrightnessGridCommand`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -1262,8 +1210,6 @@ struct BrightnessGridCommand */*notnull*/ sp_brightnessgridcommand_from_grid(Bri BrightnessGrid */*notnull*/ sp_brightnessgridcommand_get_grid_mut(struct BrightnessGridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::BrightnessGridCommand::get_origin`]. - * * Reads the origin field of the [`BrightnessGridCommand`]. * * This function is part of the `brightnessgridcommand` module. @@ -1286,8 +1232,6 @@ struct BrightnessGridCommand */*notnull*/ sp_brightnessgridcommand_new(Brightnes size_t origin_y); /** - * Calls method [`servicepoint::BrightnessGridCommand::set_grid`]. - * * Sets the value of field `grid` of the [`servicepoint::BrightnessGridCommand`]. * The provided value is moved into the instance, potentially invalidating previously taken references. * @@ -1297,8 +1241,6 @@ void sp_brightnessgridcommand_set_grid(struct BrightnessGridCommand */*notnull*/ BrightnessGrid */*notnull*/ value); /** - * Calls method [`servicepoint::BrightnessGridCommand::set_origin`]. - * * Overwrites the origin field of the [`BrightnessGridCommand`]. * * This function is part of the `brightnessgridcommand` module. @@ -1308,8 +1250,6 @@ void sp_brightnessgridcommand_set_origin(struct BrightnessGridCommand */*notnull size_t origin_y); /** - * Calls method [`servicepoint::BrightnessGridCommand::try_into_packet`]. - * *Tries to turn a [`BrightnessGridCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -1328,8 +1268,6 @@ struct Packet *sp_brightnessgridcommand_try_into_packet(struct BrightnessGridCom CharGrid */*notnull*/ sp_chargrid_clone(CharGrid */*notnull*/ instance); /** - * Calls method [`servicepoint::CharGrid::fill`]. - * * Sets the value of all cells in the grid. * * # Arguments @@ -1342,8 +1280,6 @@ CharGrid */*notnull*/ sp_chargrid_clone(CharGrid */*notnull*/ instance); void sp_chargrid_fill(CharGrid */*notnull*/ instance, uint32_t value); /** - * Calls method [`servicepoint::CharGrid::free`]. - * *Deallocates a [`CharGrid`] instance. * * This function is part of the `chargrid` module. @@ -1351,8 +1287,6 @@ void sp_chargrid_fill(CharGrid */*notnull*/ instance, uint32_t value); void sp_chargrid_free(CharGrid */*notnull*/ instance); /** - * Calls method [`servicepoint::CharGrid::get`]. - * * Returns the current value at the specified position. * * # Arguments @@ -1404,8 +1338,6 @@ CharGrid *sp_chargrid_load(size_t width, size_t height, struct ByteSlice data); CharGrid */*notnull*/ sp_chargrid_new(size_t width, size_t height); /** - * Calls method [`servicepoint::CharGrid::set`]. - * * Sets the value of the specified position in the grid. * * # Arguments @@ -1428,8 +1360,6 @@ void sp_chargrid_set(CharGrid */*notnull*/ instance, uint32_t value); /** - * Calls method [`servicepoint::CharGrid::try_into_packet`]. - * * Creates a [CharGridCommand] and immediately turns that into a [Packet]. * * The provided [CharGrid] gets consumed. @@ -1461,8 +1391,6 @@ size_t sp_chargrid_width(CharGrid */*notnull*/ instance); struct CharGridCommand */*notnull*/ sp_chargridcommand_clone(struct CharGridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::CharGridCommand::free`]. - * *Deallocates a [`CharGridCommand`] instance. * * This function is part of the `chargridcommand` module. @@ -1478,8 +1406,6 @@ void sp_chargridcommand_free(struct CharGridCommand */*notnull*/ instance); struct CharGridCommand */*notnull*/ sp_chargridcommand_from_grid(CharGrid */*notnull*/ grid); /** - * Calls method [`servicepoint::CharGridCommand::get_grid_mut`]. - * * Gets a reference to the field `grid` of the [`servicepoint::CharGridCommand`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -1490,8 +1416,6 @@ struct CharGridCommand */*notnull*/ sp_chargridcommand_from_grid(CharGrid */*not CharGrid */*notnull*/ sp_chargridcommand_get_grid_mut(struct CharGridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::CharGridCommand::get_origin`]. - * * Reads the origin field of the [`CharGridCommand`]. * * This function is part of the `chargridcommand` module. @@ -1514,8 +1438,6 @@ struct CharGridCommand */*notnull*/ sp_chargridcommand_new(CharGrid */*notnull*/ size_t origin_y); /** - * Calls method [`servicepoint::CharGridCommand::set_grid`]. - * * Sets the value of field `grid` of the [`servicepoint::CharGridCommand`]. * The provided value is moved into the instance, potentially invalidating previously taken references. * @@ -1525,8 +1447,6 @@ void sp_chargridcommand_set_grid(struct CharGridCommand */*notnull*/ instance, CharGrid */*notnull*/ value); /** - * Calls method [`servicepoint::CharGridCommand::set_origin`]. - * * Overwrites the origin field of the [`CharGridCommand`]. * * This function is part of the `chargridcommand` module. @@ -1536,8 +1456,6 @@ void sp_chargridcommand_set_origin(struct CharGridCommand */*notnull*/ command, size_t origin_y); /** - * Calls method [`servicepoint::CharGridCommand::try_into_packet`]. - * *Tries to turn a [`CharGridCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -1556,8 +1474,6 @@ struct Packet *sp_chargridcommand_try_into_packet(struct CharGridCommand */*notn struct ClearCommand */*notnull*/ sp_clearcommand_clone(struct ClearCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::ClearCommand::free`]. - * *Deallocates a [`ClearCommand`] instance. * * This function is part of the `clearcommand` module. @@ -1576,8 +1492,6 @@ void sp_clearcommand_free(struct ClearCommand */*notnull*/ instance); struct ClearCommand */*notnull*/ sp_clearcommand_new(void); /** - * Calls method [`servicepoint::ClearCommand::try_into_packet`]. - * *Tries to turn a [`ClearCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -1620,8 +1534,6 @@ struct ByteSlice sp_cp437grid_data_ref_mut(Cp437Grid */*notnull*/ instance); void sp_cp437grid_fill(Cp437Grid */*notnull*/ instance, uint8_t value); /** - * Calls method [`servicepoint::Cp437Grid::free`]. - * *Deallocates a [`Cp437Grid`] instance. * * This function is part of the `cp437grid` module. @@ -1694,8 +1606,6 @@ void sp_cp437grid_set(Cp437Grid */*notnull*/ instance, uint8_t value); /** - * Calls method [`servicepoint::Cp437Grid::try_into_packet`]. - * * Creates a [Cp437GridCommand] and immediately turns that into a [Packet]. * * The provided [Cp437Grid] gets consumed. @@ -1727,8 +1637,6 @@ size_t sp_cp437grid_width(Cp437Grid */*notnull*/ instance); struct Cp437GridCommand */*notnull*/ sp_cp437gridcommand_clone(struct Cp437GridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::Cp437GridCommand::free`]. - * *Deallocates a [`Cp437GridCommand`] instance. * * This function is part of the `cp437gridcommand` module. @@ -1744,8 +1652,6 @@ void sp_cp437gridcommand_free(struct Cp437GridCommand */*notnull*/ instance); struct Cp437GridCommand */*notnull*/ sp_cp437gridcommand_from_grid(Cp437Grid */*notnull*/ grid); /** - * Calls method [`servicepoint::Cp437GridCommand::get_grid_mut`]. - * * Gets a reference to the field `grid` of the [`servicepoint::Cp437GridCommand`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -1756,8 +1662,6 @@ struct Cp437GridCommand */*notnull*/ sp_cp437gridcommand_from_grid(Cp437Grid */* Cp437Grid */*notnull*/ sp_cp437gridcommand_get_grid_mut(struct Cp437GridCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::Cp437GridCommand::get_origin`]. - * * Reads the origin field of the [`Cp437GridCommand`]. * * This function is part of the `cp437gridcommand` module. @@ -1780,8 +1684,6 @@ struct Cp437GridCommand */*notnull*/ sp_cp437gridcommand_new(Cp437Grid */*notnul size_t origin_y); /** - * Calls method [`servicepoint::Cp437GridCommand::set_grid`]. - * * Sets the value of field `grid` of the [`servicepoint::Cp437GridCommand`]. * The provided value is moved into the instance, potentially invalidating previously taken references. * @@ -1791,8 +1693,6 @@ void sp_cp437gridcommand_set_grid(struct Cp437GridCommand */*notnull*/ instance, Cp437Grid */*notnull*/ value); /** - * Calls method [`servicepoint::Cp437GridCommand::set_origin`]. - * * Overwrites the origin field of the [`Cp437GridCommand`]. * * This function is part of the `cp437gridcommand` module. @@ -1802,8 +1702,6 @@ void sp_cp437gridcommand_set_origin(struct Cp437GridCommand */*notnull*/ command size_t origin_y); /** - * Calls method [`servicepoint::Cp437GridCommand::try_into_packet`]. - * *Tries to turn a [`Cp437GridCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -1846,8 +1744,6 @@ DisplayBitVec */*notnull*/ sp_displaybitvec_clone(DisplayBitVec */*notnull*/ ins void sp_displaybitvec_fill(DisplayBitVec */*notnull*/ instance, bool value); /** - * Calls method [`servicepoint::DisplayBitVec::free`]. - * *Deallocates a [`DisplayBitVec`] instance. * * This function is part of the `displaybitvec` module. @@ -1855,8 +1751,6 @@ void sp_displaybitvec_fill(DisplayBitVec */*notnull*/ instance, bool value); void sp_displaybitvec_free(DisplayBitVec */*notnull*/ instance); /** - * Calls method [`servicepoint::DisplayBitVec::get`]. - * * Gets the value of a bit. * * # Arguments @@ -1939,8 +1833,6 @@ void sp_displaybitvec_set(DisplayBitVec */*notnull*/ instance, bool value); /** - * Calls method [`servicepoint::DisplayBitVec::try_into_packet`]. - * * Creates a [BitVecCommand] and immediately turns that into a [Packet]. * * The provided [DisplayBitVec] gets consumed. @@ -1972,8 +1864,6 @@ void sp_envlogger_init(void); struct FadeOutCommand */*notnull*/ sp_fadeoutcommand_clone(struct FadeOutCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::FadeOutCommand::free`]. - * *Deallocates a [`FadeOutCommand`] instance. * * This function is part of the `fadeoutcommand` module. @@ -1990,8 +1880,6 @@ void sp_fadeoutcommand_free(struct FadeOutCommand */*notnull*/ instance); struct FadeOutCommand */*notnull*/ sp_fadeoutcommand_new(void); /** - * Calls method [`servicepoint::FadeOutCommand::try_into_packet`]. - * *Tries to turn a [`FadeOutCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -2010,8 +1898,6 @@ struct Packet *sp_fadeoutcommand_try_into_packet(struct FadeOutCommand */*notnul struct GenericCommand */*notnull*/ sp_genericcommand_clone(struct GenericCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::GenericCommand::free`]. - * *Deallocates a [`GenericCommand`] instance. * * This function is part of the `genericcommand` module. @@ -2030,8 +1916,6 @@ void sp_genericcommand_free(struct GenericCommand */*notnull*/ instance); struct GenericCommand */*notnull*/ sp_genericcommand_try_from_packet(struct Packet */*notnull*/ packet); /** - * Calls method [`servicepoint::GenericCommand::try_into_packet`]. - * * Tries to turn a [GenericCommand] into a [Packet]. * The [GenericCommand] gets consumed. * @@ -2051,8 +1935,6 @@ struct Packet *sp_genericcommand_try_into_packet(struct GenericCommand */*notnul struct GlobalBrightnessCommand */*notnull*/ sp_globalbrightnesscommand_clone(struct GlobalBrightnessCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::GlobalBrightnessCommand::free`]. - * *Deallocates a [`GlobalBrightnessCommand`] instance. * * This function is part of the `globalbrightnesscommand` module. @@ -2060,8 +1942,6 @@ struct GlobalBrightnessCommand */*notnull*/ sp_globalbrightnesscommand_clone(str void sp_globalbrightnesscommand_free(struct GlobalBrightnessCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::GlobalBrightnessCommand::get_brightness`]. - * * Gets the value of field `brightness` of the [`servicepoint::GlobalBrightnessCommand`]. * * This function is part of the `globalbrightnesscommand` module. @@ -2078,8 +1958,6 @@ Brightness sp_globalbrightnesscommand_get_brightness(struct GlobalBrightnessComm struct GlobalBrightnessCommand */*notnull*/ sp_globalbrightnesscommand_new(Brightness brightness); /** - * Calls method [`servicepoint::GlobalBrightnessCommand::set_brightness`]. - * * Sets the value of field `brightness` of the [`servicepoint::GlobalBrightnessCommand`]. * * This function is part of the `globalbrightnesscommand` module. @@ -2088,8 +1966,6 @@ void sp_globalbrightnesscommand_set_brightness(struct GlobalBrightnessCommand */ Brightness value); /** - * Calls method [`servicepoint::GlobalBrightnessCommand::try_into_packet`]. - * *Tries to turn a [`GlobalBrightnessCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -2108,8 +1984,6 @@ struct Packet *sp_globalbrightnesscommand_try_into_packet(struct GlobalBrightnes struct HardResetCommand */*notnull*/ sp_hardresetcommand_clone(struct HardResetCommand */*notnull*/ instance); /** - * Calls method [`servicepoint::HardResetCommand::free`]. - * *Deallocates a [`HardResetCommand`] instance. * * This function is part of the `hardresetcommand` module. @@ -2128,8 +2002,6 @@ void sp_hardresetcommand_free(struct HardResetCommand */*notnull*/ instance); struct HardResetCommand */*notnull*/ sp_hardresetcommand_new(void); /** - * Calls method [`servicepoint::HardResetCommand::try_into_packet`]. - * *Tries to turn a [`HardResetCommand`] into a [Packet]. * * Returns: NULL or a [Packet] containing the command. @@ -2148,8 +2020,6 @@ struct Packet *sp_hardresetcommand_try_into_packet(struct HardResetCommand */*no struct Packet */*notnull*/ sp_packet_clone(struct Packet */*notnull*/ instance); /** - * Calls method [`servicepoint::Packet::free`]. - * *Deallocates a [`Packet`] instance. * * This function is part of the `packet` module. @@ -2167,8 +2037,6 @@ struct Packet */*notnull*/ sp_packet_from_parts(struct Header header, struct ByteSlice payload); /** - * Calls method [`servicepoint::Packet::get_header`]. - * * Gets the value of field `header` of the [`servicepoint::Packet`]. * * This function is part of the `packet` module. @@ -2176,8 +2044,6 @@ struct Packet */*notnull*/ sp_packet_from_parts(struct Header header, struct Header sp_packet_get_header(struct Packet */*notnull*/ instance); /** - * Calls method [`servicepoint::Packet::get_header_mut`]. - * * Gets a reference to the field `header` of the [`servicepoint::Packet`]. * * - The returned reference inherits the lifetime of object in which it is contained. @@ -2188,8 +2054,6 @@ struct Header sp_packet_get_header(struct Packet */*notnull*/ instance); struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ instance); /** - * Calls method [`servicepoint::Packet::get_payload`]. - * * Returns a pointer to the current payload of the provided packet. * * Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload. @@ -2201,8 +2065,6 @@ struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ i struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet); /** - * Calls method [`servicepoint::Packet::serialize_to`]. - * * Serialize the packet into the provided buffer. * * # Panics @@ -2215,8 +2077,6 @@ size_t sp_packet_serialize_to(struct Packet */*notnull*/ packet, struct ByteSlice buffer); /** - * Calls method [`servicepoint::Packet::set_header`]. - * * Sets the value of field `header` of the [`servicepoint::Packet`]. * * This function is part of the `packet` module. @@ -2225,8 +2085,6 @@ void sp_packet_set_header(struct Packet */*notnull*/ instance, struct Header value); /** - * Calls method [`servicepoint::Packet::set_payload`]. - * * Sets the payload of the provided packet to the provided data. * * This makes previous payload pointers invalid. @@ -2256,8 +2114,6 @@ bool sp_sp_u16_to_command_code(uint16_t code, CommandCode */*notnull*/ result); /** - * Calls method [`servicepoint::UdpSocket::free`]. - * *Deallocates a [`UdpSocket`] instance. * * This function is part of the `udpsocket` module. @@ -2303,8 +2159,6 @@ struct UdpSocket *sp_udpsocket_open_ipv4(uint8_t ip1, uint16_t port); /** - * Calls method [`servicepoint::UdpSocket::send_command`]. - * * Sends a [GenericCommand] to the display using the [UdpSocket]. * * The passed `command` gets consumed. @@ -2323,8 +2177,6 @@ bool sp_udpsocket_send_command(struct UdpSocket */*notnull*/ connection, struct GenericCommand */*notnull*/ command); /** - * Calls method [`servicepoint::UdpSocket::send_header`]. - * * Sends a [Header] to the display using the [UdpSocket]. * * returns: true in case of success @@ -2341,8 +2193,6 @@ bool sp_udpsocket_send_header(struct UdpSocket */*notnull*/ udp_connection, struct Header header); /** - * Calls method [`servicepoint::UdpSocket::send_packet`]. - * * Sends a [Packet] to the display using the [UdpSocket]. * * The passed `packet` gets consumed. diff --git a/src/commands/mod.rs b/src/commands/mod.rs index e3e3715..c8e9dfc 100644 --- a/src/commands/mod.rs +++ b/src/commands/mod.rs @@ -62,6 +62,8 @@ macro_rules! derive_command_into_packet { #[doc = "Tries to turn a [`" $command_type "`] into a [Packet]."] /// /// Returns: NULL or a [Packet] containing the command. + /// + /// [Packet]: [`servicepoint::Packet`] fn try_into_packet(move instance) -> move_ok *mut ::servicepoint::Packet { instance.try_into() }; diff --git a/src/macros.rs b/src/macros.rs index 5ddb7f9..34e94e8 100644 --- a/src/macros.rs +++ b/src/macros.rs @@ -14,9 +14,7 @@ macro_rules! derive_clone { ($object_type:ident) => { $crate::macros::wrap_method!($object_type; #[doc = concat!("Clones a [`", stringify!($object_type), "`] instance.")] - fn clone(ref instance) -> move ::core::ptr::NonNull<$object_type> { - instance.clone() - }; + fn clone(ref instance) -> move ::core::ptr::NonNull<$object_type>; ); }; } @@ -31,6 +29,8 @@ macro_rules! wrap_method { ::paste::paste!{ $crate::macros::wrap_method!( $object_type; + #[doc = " Calls method [`" $object_type "::" $function "`]."] + /// $(#[$meta])+ fn $function($ref_or_mut $instance $(, $($param_name: $param_modifier $param_type),*)?) $(-> $return_modifier $return_type)? { @@ -47,8 +47,6 @@ macro_rules! wrap_method { ) => { paste::paste! { $crate::macros::wrap_functions!([< $object_type:lower >]; - #[doc = " Calls method [`servicepoint::" $object_type "::" $function "`]."] - /// $(#[$meta])* fn $function( $instance: $ref_or_mut ::core::ptr::NonNull<$object_type>