From 89122240c124e7dce4066d423985ab03e36d384c Mon Sep 17 00:00:00 2001 From: tterrag1098 Date: Tue, 5 May 2015 12:20:12 -0400 Subject: [PATCH] Fix javadoc errors --- build.gradle | 6 ++-- .../api/common/config/IConfigHandler.java | 33 +++++++++---------- .../core/client/gui/button/IconButton.java | 2 +- .../com/enderio/core/common/Handlers.java | 2 +- .../core/common/util/EnderStringUtils.java | 6 ++-- 5 files changed, 23 insertions(+), 26 deletions(-) diff --git a/build.gradle b/build.gradle index 4fd5fc6..d5fb6b8 100644 --- a/build.gradle +++ b/build.gradle @@ -101,12 +101,12 @@ task deobfJar(type: Jar) { classifier = 'dev' } -task exportJavadoc(type: Javadoc) { +javadoc { + options.addStringOption('Xdoclint:none', '-quiet') include 'com/enderio/core/**/*' - source = sourceSets.main.allSource } -build.dependsOn sourceJar, deobfJar, apiJar, exportJavadoc +build.dependsOn sourceJar, deobfJar, apiJar, javadoc publishing { tasks.publish.dependsOn 'build' diff --git a/src/main/java/com/enderio/core/api/common/config/IConfigHandler.java b/src/main/java/com/enderio/core/api/common/config/IConfigHandler.java index ed78238..e9ee434 100644 --- a/src/main/java/com/enderio/core/api/common/config/IConfigHandler.java +++ b/src/main/java/com/enderio/core/api/common/config/IConfigHandler.java @@ -9,25 +9,22 @@ import net.minecraftforge.common.config.ConfigCategory; import cpw.mods.fml.common.event.FMLInitializationEvent; import cpw.mods.fml.common.event.FMLPostInitializationEvent; -public interface IConfigHandler -{ - void initialize(File cfg); +public interface IConfigHandler { + void initialize(File cfg); - List
getSections(); + List
getSections(); - ConfigCategory getCategory(String name); + ConfigCategory getCategory(String name); - String getModID(); - - /** - * A hook for the {@link FMLInitializationEvent}, also called during config reloads depending on - * {@link #shouldHookOnReload()} - */ - void initHook(); - - /** - * A hook for the {@link FMLPostInitializationEvent}, also called during config reloads - * depending on {@link #shouldHookOnReload()} - */ - void postInitHook(); + String getModID(); + + /** + * A hook for the {@link FMLInitializationEvent}. + */ + void initHook(); + + /** + * A hook for the {@link FMLPostInitializationEvent}. + */ + void postInitHook(); } diff --git a/src/main/java/com/enderio/core/client/gui/button/IconButton.java b/src/main/java/com/enderio/core/client/gui/button/IconButton.java index 79181e6..1510bd9 100644 --- a/src/main/java/com/enderio/core/client/gui/button/IconButton.java +++ b/src/main/java/com/enderio/core/client/gui/button/IconButton.java @@ -118,7 +118,7 @@ public class IconButton extends GuiButton { * @param y * Y coordinate of mouse click * @param button - * the mouse button - only called for button >= 1 + * the mouse button - only called for button {@literal >}= 1 * @return true if the mouse click is handled */ public boolean mousePressedButton(Minecraft mc, int x, int y, int button) { diff --git a/src/main/java/com/enderio/core/common/Handlers.java b/src/main/java/com/enderio/core/common/Handlers.java index ded1e88..33e05da 100644 --- a/src/main/java/com/enderio/core/common/Handlers.java +++ b/src/main/java/com/enderio/core/common/Handlers.java @@ -56,7 +56,7 @@ public class Handlers FORGE, /** - * Represents the {@link FMLCommonHandler#instance()#bus()} + * Represents the {@link FMLCommonHandler#bus()} */ FML } diff --git a/src/main/java/com/enderio/core/common/util/EnderStringUtils.java b/src/main/java/com/enderio/core/common/util/EnderStringUtils.java index 247acb9..2872b16 100644 --- a/src/main/java/com/enderio/core/common/util/EnderStringUtils.java +++ b/src/main/java/com/enderio/core/common/util/EnderStringUtils.java @@ -103,9 +103,9 @@ public class EnderStringUtils * @param max * The max number * - * @return if num <= 10% of max : RED
- * if 10% < num <= 25% of max: GOLD (orange-ish)
- * if num > 25% of max: GREEN + * @return if num {@literal <}= 10% of max : RED
+ * if 10% {@literal <} num {@literal <}= 25% of max: GOLD (orange-ish)
+ * if num {@literal >} 25% of max: GREEN */ public EnumChatFormatting getColorFor(double num, double max) {