mirror of
https://github.com/StarWishsama/Slimefun4.git
synced 2024-09-19 19:25:48 +00:00
[CI skip] Fixed javadocs
This commit is contained in:
TheBusyBiscuit
parent
4a9124b1e3
commit
a9c330d6a3
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package contains a few classes that revolve around the API for
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}, such as
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}, such as
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.ItemSetting}
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.api.items;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds everything connected to the {@link io.github.thebusybiscuit.slimefun4.core.researching.Research}
|
||||
* This package holds everything connected to the {@link io.github.thebusybiscuit.slimefun4.api.researches.Research}
|
||||
* class.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.api.researches;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package contains all variations of {@link io.github.thebusybiscuit.slimefun4.core.attributes.ItemAttribute} that
|
||||
* can be assigned to a {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* can be assigned to a {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.core.attributes;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package contains all variations of {@link me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler} that
|
||||
* can be assigned to a {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package contains all variations of {@link io.github.thebusybiscuit.slimefun4.api.items.ItemHandler} that
|
||||
* can be assigned to a {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.core.handlers;
|
||||
@ -9,12 +9,13 @@ import org.bukkit.plugin.Plugin;
|
||||
|
||||
import io.github.bakedlibs.dough.config.Config;
|
||||
import io.github.bakedlibs.dough.updater.GitHubBuildsUpdater;
|
||||
import io.github.bakedlibs.dough.updater.PluginUpdater;
|
||||
import io.github.bakedlibs.dough.versions.PrefixedVersion;
|
||||
import io.github.thebusybiscuit.slimefun4.api.SlimefunBranch;
|
||||
import io.github.thebusybiscuit.slimefun4.implementation.Slimefun;
|
||||
|
||||
/**
|
||||
* This Class represents our {@link Updater} Service.
|
||||
* This Class represents our {@link PluginUpdater} Service.
|
||||
* If enabled, it will automatically connect to https://thebusybiscuit.github.io/builds/
|
||||
* to check for updates and to download them automatically.
|
||||
*
|
||||
@ -29,9 +30,9 @@ public class UpdaterService {
|
||||
private final Slimefun plugin;
|
||||
|
||||
/**
|
||||
* Our {@link Updater} implementation.
|
||||
* Our {@link PluginUpdater} implementation.
|
||||
*/
|
||||
private final GitHubBuildsUpdater updater;
|
||||
private final PluginUpdater<PrefixedVersion> updater;
|
||||
|
||||
/**
|
||||
* The {@link SlimefunBranch} we are currently on.
|
||||
@ -126,11 +127,11 @@ public class UpdaterService {
|
||||
}
|
||||
|
||||
/**
|
||||
* This returns whether the {@link Updater} is enabled or not.
|
||||
* This returns whether the {@link PluginUpdater} is enabled or not.
|
||||
* This includes the {@link Config} setting but also whether or not we are running an
|
||||
* official or unofficial build.
|
||||
*
|
||||
* @return Whether the {@link Updater} is enabled
|
||||
* @return Whether the {@link PluginUpdater} is enabled
|
||||
*/
|
||||
public boolean isEnabled() {
|
||||
return Slimefun.getCfg().getBoolean("options.auto-update") && updater != null;
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
* {@link io.github.thebusybiscuit.slimefun4.core.services.profiler.SlimefunProfiler}.
|
||||
* The {@link io.github.thebusybiscuit.slimefun4.core.services.profiler.SlimefunProfiler} is used to determine
|
||||
* {@link org.bukkit.block.Block Blocks}, {@link org.bukkit.Chunk Chunks} or
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem SlimefunItems} that cause lag or performance
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem SlimefunItems} that cause lag or performance
|
||||
* drops.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.core.services.profiler;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds simple implementations of {@link me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler}.
|
||||
* This package holds simple implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.ItemHandler}.
|
||||
* These are just handlers that can be re-used frequently.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.handlers;
|
||||
@ -66,10 +66,7 @@ public abstract class LimitedUseItem extends SimpleSlimefunItem<ItemUseHandler>
|
||||
*
|
||||
* @param count
|
||||
* The maximum number of times this item can be used.
|
||||
* <<<<<<< HEAD
|
||||
* =======
|
||||
*
|
||||
* >>>>>>> branch 'master' of https://github.com/Slimefun/Slimefun4.git
|
||||
* @return The {@link LimitedUseItem} for chaining of setters
|
||||
*/
|
||||
public final @Nonnull LimitedUseItem setMaxUseCount(int count) {
|
||||
|
||||
@ -30,7 +30,7 @@ public class VanillaItem extends SlimefunItem {
|
||||
* Instantiates a new {@link VanillaItem} with the given arguments.
|
||||
*
|
||||
* @param itemGroup
|
||||
* the {@Link ItemGroup} to bind this {@link VanillaItem} to
|
||||
* the {@link ItemGroup} to bind this {@link VanillaItem} to
|
||||
* @param item
|
||||
* the item corresponding to this {@link VanillaItem}
|
||||
* @param id
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds the {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} implementations related to
|
||||
* This package holds the {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} implementations related to
|
||||
* the {@link io.github.thebusybiscuit.slimefun4.implementation.items.altar.AncientAltar}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.altar;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are related to the {@link io.github.thebusybiscuit.slimefun4.implementation.items.androids.ProgrammableAndroid}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.androids;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package contains implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that are
|
||||
* This package contains implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that are
|
||||
* related to armor, such as the expandable
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.armor.SlimefunArmorPiece} class for example.
|
||||
*/
|
||||
|
||||
@ -29,7 +29,7 @@ public class RestoredBackpack extends SlimefunBackpack {
|
||||
* This will create a new {@link SlimefunBackpack} with the given arguments.
|
||||
*
|
||||
* @param itemGroup
|
||||
* the {@Link ItemGroup} to bind this {@link SlimefunBackpack} to
|
||||
* the {@link ItemGroup} to bind this {@link SlimefunBackpack} to
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
public RestoredBackpack(@Nonnull ItemGroup itemGroup) {
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package contains a few miscellaneous implementations of
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} which are blocks.
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} which are blocks.
|
||||
* Such as the {@link io.github.thebusybiscuit.slimefun4.implementation.items.blocks.BlockPlacer} for example.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.blocks;
|
||||
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package provides the different implementations of
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are related to the {@link io.github.thebusybiscuit.slimefun4.core.networks.cargo.CargoNet}, most
|
||||
* notably: Cargo Nodes.
|
||||
*/
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are used in combination with electricity, like the
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.electric.gadgets.Multimeter} or the
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.electric.gadgets.SolarHelmet}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package contains the different implementations of
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that are also an
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that are also an
|
||||
* {@link io.github.thebusybiscuit.slimefun4.core.attributes.EnergyNetComponent} with the type {@code CONSUMER}.
|
||||
*
|
||||
* Machines do not generate power, they consume it.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package contains the different implementations of
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that also implement the interface
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that also implement the interface
|
||||
* {@link io.github.thebusybiscuit.slimefun4.core.attributes.EnergyNetComponent}
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.electric;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are related to food.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.food;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of any {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that
|
||||
* This package holds implementations of any {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that
|
||||
* deals with the {@link io.github.thebusybiscuit.slimefun4.api.geo.GEOResource} API.
|
||||
* The most prominent example of this being the
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.geo.GEOScanner} and the
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are related to the {@link io.github.thebusybiscuit.slimefun4.api.gps.GPSNetwork}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.gps;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are considered magical items.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.magical;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds any implementation of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds any implementation of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that is an ancient rune with functionality.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.magical.runes;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds any implementation of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that is
|
||||
* This package holds any implementation of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that is
|
||||
* considered a "Magical Staff".
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.magical.staves;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds any {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} related to the
|
||||
* This package holds any {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} related to the
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.magical.talismans.Talisman}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.magical.talismans;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} that are
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} that are
|
||||
* related to healing yourself.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.medical;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds any miscellaneous {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds any miscellaneous {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* implementations.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.misc;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package contains the different classes for each
|
||||
* {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are related to the {@link io.github.thebusybiscuit.slimefun4.implementation.items.teleporter.Teleporter}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.teleporter;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are tools.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation.items.tools;
|
||||
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* This package holds implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
|
||||
* This package holds implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem}
|
||||
* that are weapons, implementations of
|
||||
* {@link io.github.thebusybiscuit.slimefun4.implementation.items.weapons.SlimefunBow} for example.
|
||||
*/
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* This package holds all classes that are related to the actual implementation of this plugin.
|
||||
* This includes implementations of {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem} but also any
|
||||
* This includes implementations of {@link io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem} but also any
|
||||
* {@link org.bukkit.event.Listener}.
|
||||
*/
|
||||
package io.github.thebusybiscuit.slimefun4.implementation;
|
||||
Loading…
Reference in New Issue
Block a user