From f5280465354d63f600e7bc62a0a9e289d5efe55b Mon Sep 17 00:00:00 2001 From: Jonathan Coates Date: Mon, 31 Oct 2022 20:09:47 +0000 Subject: [PATCH] Add a whole bunch of missing @since annotations --- .../shared/peripheral/generic/methods/EnergyMethods.java | 1 + .../shared/peripheral/generic/methods/FluidMethods.java | 1 + .../shared/peripheral/generic/methods/InventoryMethods.java | 2 ++ src/main/resources/data/computercraft/lua/rom/help/changelog.md | 2 +- .../data/computercraft/lua/rom/modules/main/cc/audio/dfpwm.lua | 2 +- 5 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/EnergyMethods.java b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/EnergyMethods.java index 3bb359167..ff4eb4a67 100644 --- a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/EnergyMethods.java +++ b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/EnergyMethods.java @@ -25,6 +25,7 @@ import javax.annotation.Nonnull; * ::: * * @cc.module energy_storage + * @cc.since 1.94.0 */ public class EnergyMethods implements GenericPeripheral { diff --git a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/FluidMethods.java b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/FluidMethods.java index 260d491ec..ad35ff60a 100644 --- a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/FluidMethods.java +++ b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/FluidMethods.java @@ -35,6 +35,7 @@ import static dan200.computercraft.shared.peripheral.generic.methods.ArgumentHel * Methods for interacting with tanks and other fluid storage blocks. * * @cc.module fluid_storage + * @cc.since 1.94.0 */ public class FluidMethods implements GenericPeripheral { diff --git a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/InventoryMethods.java b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/InventoryMethods.java index b8cf441e4..41dc54a7b 100644 --- a/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/InventoryMethods.java +++ b/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/InventoryMethods.java @@ -36,6 +36,7 @@ import static dan200.computercraft.shared.peripheral.generic.methods.ArgumentHel * Methods for interacting with inventories. * * @cc.module inventory + * @cc.since 1.94.0 */ public class InventoryMethods implements GenericPeripheral { @@ -168,6 +169,7 @@ public class InventoryMethods implements GenericPeripheral * end * print(total) * } + * @cc.since 1.96.0 */ @LuaFunction( mainThread = true ) public static int getItemLimit( IItemHandler inventory, int slot ) throws LuaException diff --git a/src/main/resources/data/computercraft/lua/rom/help/changelog.md b/src/main/resources/data/computercraft/lua/rom/help/changelog.md index 91b688894..87881bae4 100644 --- a/src/main/resources/data/computercraft/lua/rom/help/changelog.md +++ b/src/main/resources/data/computercraft/lua/rom/help/changelog.md @@ -222,7 +222,7 @@ And several bug fixes: # New features in CC: Tweaked 1.96.0 * Use lightGrey for folders within the "list" program. -* Add getLimit to inventory peripherals. +* Add `getItemLimit` to inventory peripherals. * Expose the generic peripheral system to the public API. * Add cc.expect.range (Lupus590). * Allow calling cc.expect directly (MCJack123). diff --git a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/audio/dfpwm.lua b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/audio/dfpwm.lua index fd8fa2686..fc8e8fa66 100644 --- a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/audio/dfpwm.lua +++ b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/audio/dfpwm.lua @@ -27,9 +27,9 @@ application or development builds of [FFmpeg]. @see guide!speaker_audio Gives a more general introduction to audio processing and the speaker. @see speaker.playAudio To play the decoded audio data. +@since 1.100.0 @usage Reads "data/example.dfpwm" in chunks, decodes them and then doubles the speed of the audio. The resulting audio is then re-encoded and saved to "speedy.dfpwm". This processed audio can then be played with the `speaker` program. -@since 1.100.0 ```lua local dfpwm = require("cc.audio.dfpwm")