diff --git a/build.gradle b/build.gradle index e19ddfc25..3ca948a14 100644 --- a/build.gradle +++ b/build.gradle @@ -123,7 +123,7 @@ dependencies { deployerJars "org.apache.maven.wagon:wagon-ssh:3.0.0" - cctJavadoc 'cc.tweaked:cct-javadoc:1.2.1' + cctJavadoc 'cc.tweaked:cct-javadoc:1.3.0' } // Compile tasks @@ -346,6 +346,7 @@ task illuaminateDocs(type: Exec, dependsOn: [minifyWeb, luaJavadoc]) { inputs.files(fileTree("doc")).withPropertyName("docs") inputs.files(fileTree("src/main/resources/data/computercraft/lua/rom")).withPropertyName("lua rom") inputs.file("illuaminate.sexp").withPropertyName("illuaminate.sexp") + inputs.dir("$buildDir/docs/luaJavadoc") inputs.file("$buildDir/rollup/index.min.js").withPropertyName("scripts") inputs.file("src/web/styles.css").withPropertyName("styles") outputs.dir("$buildDir/docs/lua") diff --git a/illuaminate.sexp b/illuaminate.sexp index 6bf2d2688..d020482f9 100644 --- a/illuaminate.sexp +++ b/illuaminate.sexp @@ -19,7 +19,8 @@ (source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line}) (module-kinds - (peripheral Peripherals)) + (peripheral Peripherals) + (generic_peripheral "Generic Peripherals")) (library-path /doc/stub/ @@ -91,6 +92,10 @@ /build/docs/luaJavadoc/drive.lua /build/docs/luaJavadoc/speaker.lua /build/docs/luaJavadoc/printer.lua + ; Generic peripherals + /build/docs/luaJavadoc/energy_storage.lua + /build/docs/luaJavadoc/fluid_storage.lua + /build/docs/luaJavadoc/inventory.lua ; Lua APIs /src/main/resources/*/computercraft/lua/rom/apis/io.lua /src/main/resources/*/computercraft/lua/rom/apis/window.lua) 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 1123318d3..6d0d705ff 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 @@ -15,6 +15,11 @@ import net.minecraftforge.versions.forge.ForgeVersion; import javax.annotation.Nonnull; +/** + * Methods for interacting with blocks using Forge's energy storage system. + * + * @cc.module energy_storage + */ @AutoService( GenericSource.class ) public class EnergyMethods implements GenericSource { 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 26b631f68..1dfe5a2a0 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 @@ -31,6 +31,11 @@ import java.util.Optional; import static dan200.computercraft.shared.peripheral.generic.methods.ArgumentHelpers.getRegistryEntry; +/** + * Methods for interacting with tanks and other fluid storage blocks. + * + * @cc.module fluid_storage + */ @AutoService( GenericSource.class ) public class FluidMethods implements GenericSource { 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 405532b0b..e2e5269c9 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 @@ -32,6 +32,11 @@ import java.util.Optional; import static dan200.computercraft.shared.peripheral.generic.methods.ArgumentHelpers.assertBetween; +/** + * Methods for interacting with inventories. + * + * @cc.module inventory + */ @AutoService( GenericSource.class ) public class InventoryMethods implements GenericSource {