Commit 859ec48139abf9655380f2feb5e6abddcbc12ed6

Authored by Mumfrey
1 parent fc0d1934

squash all javadoc warnings

Showing 79 changed files with 161 additions and 408 deletions
ant/build_liteloader.xml
@@ -309,6 +309,7 @@ @@ -309,6 +309,7 @@
309 </fileset> 309 </fileset>
310 <pathelement location="${mc.bin.dir}"/> 310 <pathelement location="${mc.bin.dir}"/>
311 </classpath> 311 </classpath>
  312 + <arg value="-XDignore.symbol.file" />
312 </javadoc> 313 </javadoc>
313 <jar destfile="${dist.dir}/${artefact.name}-javadoc.${filetype}" duplicate="preserve" index="true" manifestencoding="UTF-8"> 314 <jar destfile="${dist.dir}/${artefact.name}-javadoc.${filetype}" duplicate="preserve" index="true" manifestencoding="UTF-8">
314 <manifest> 315 <manifest>
debug/com/mumfrey/liteloader/debug/LoginPanel.java
@@ -250,7 +250,6 @@ public class LoginPanel extends JPanel @@ -250,7 +250,6 @@ public class LoginPanel extends JPanel
250 250
251 /** 251 /**
252 * @param dialog 252 * @param dialog
253 - * @param panel  
254 */ 253 */
255 public void setDialog(JDialog dialog) 254 public void setDialog(JDialog dialog)
256 { 255 {
java/client/com/mumfrey/liteloader/client/GameEngineClient.java
@@ -160,9 +160,6 @@ public class GameEngineClient implements GameEngine&lt;Minecraft, IntegratedServer&gt; @@ -160,9 +160,6 @@ public class GameEngineClient implements GameEngine&lt;Minecraft, IntegratedServer&gt;
160 return this.engine.getResourceManager(); 160 return this.engine.getResourceManager();
161 } 161 }
162 162
163 - /**  
164 - * @return  
165 - */  
166 public SoundHandler getSoundHandler() 163 public SoundHandler getSoundHandler()
167 { 164 {
168 return this.engine.getSoundHandler(); 165 return this.engine.getSoundHandler();
java/client/com/mumfrey/liteloader/client/gui/GuiLiteLoaderPanel.java
@@ -218,7 +218,7 @@ public class GuiLiteLoaderPanel extends GuiScreen @@ -218,7 +218,7 @@ public class GuiLiteLoaderPanel extends GuiScreen
218 } 218 }
219 219
220 /** 220 /**
221 - * @return 221 + * Get the computed branding colour
222 */ 222 */
223 public int getBrandColour() 223 public int getBrandColour()
224 { 224 {
@@ -242,7 +242,7 @@ public class GuiLiteLoaderPanel extends GuiScreen @@ -242,7 +242,7 @@ public class GuiLiteLoaderPanel extends GuiScreen
242 } 242 }
243 243
244 /** 244 /**
245 - * @return 245 + * Return true if the panel is not fully closed (tweening or open)
246 */ 246 */
247 public boolean isOpen() 247 public boolean isOpen()
248 { 248 {
java/client/com/mumfrey/liteloader/client/gui/GuiModListPanel.java
@@ -86,7 +86,7 @@ public class GuiModListPanel extends Gui @@ -86,7 +86,7 @@ public class GuiModListPanel extends Gui
86 * @param yPosition 86 * @param yPosition
87 * @param width 87 * @param width
88 * @param selected 88 * @param selected
89 - * @return 89 + * @return calculated height of this panel, used by the list view to calculate spacing
90 */ 90 */
91 public int draw(int mouseX, int mouseY, float partialTicks, int xPosition, int yPosition, int width, boolean selected) 91 public int draw(int mouseX, int mouseY, float partialTicks, int xPosition, int yPosition, int width, boolean selected)
92 { 92 {
@@ -163,9 +163,7 @@ public class GuiModListPanel extends Gui @@ -163,9 +163,7 @@ public class GuiModListPanel extends Gui
163 } 163 }
164 164
165 /** 165 /**
166 - * @param external  
167 * @param selected 166 * @param selected
168 - * @return  
169 */ 167 */
170 protected int getGradientColour(boolean selected) 168 protected int getGradientColour(boolean selected)
171 { 169 {
@@ -173,11 +171,7 @@ public class GuiModListPanel extends Gui @@ -173,11 +171,7 @@ public class GuiModListPanel extends Gui
173 } 171 }
174 172
175 /** 173 /**
176 - * @param missingDependencies  
177 - * @param enabled  
178 - * @param external  
179 * @param selected 174 * @param selected
180 - * @return  
181 */ 175 */
182 protected int getTitleColour(boolean selected) 176 protected int getTitleColour(boolean selected)
183 { 177 {
@@ -189,9 +183,7 @@ public class GuiModListPanel extends Gui @@ -189,9 +183,7 @@ public class GuiModListPanel extends Gui
189 } 183 }
190 184
191 /** 185 /**
192 - * @param external  
193 * @param selected 186 * @param selected
194 - * @return  
195 */ 187 */
196 protected int getStatusColour(boolean selected) 188 protected int getStatusColour(boolean selected)
197 { 189 {
java/client/com/mumfrey/liteloader/client/gui/GuiPanelMods.java
@@ -367,8 +367,7 @@ public class GuiPanelMods extends GuiPanel @@ -367,8 +367,7 @@ public class GuiPanelMods extends GuiPanel
367 } 367 }
368 368
369 /** 369 /**
370 - * @param mod  
371 - * @return 370 + * @param mod Mod list entry to select
372 */ 371 */
373 private void selectMod(ModListEntry mod) 372 private void selectMod(ModListEntry mod)
374 { 373 {
java/client/com/mumfrey/liteloader/client/gui/ModListEntry.java
@@ -104,25 +104,16 @@ public class ModListEntry @@ -104,25 +104,16 @@ public class ModListEntry
104 this.listPanel = new GuiModListPanel(this, fontRenderer, brandColour, modInfo, decorators); 104 this.listPanel = new GuiModListPanel(this, fontRenderer, brandColour, modInfo, decorators);
105 } 105 }
106 106
107 - /**  
108 - * @return  
109 - */  
110 protected String getTitleText() 107 protected String getTitleText()
111 { 108 {
112 return this.modInfo.getDisplayName(); 109 return this.modInfo.getDisplayName();
113 } 110 }
114 111
115 - /**  
116 - * @return  
117 - */  
118 protected String getVersionText() 112 protected String getVersionText()
119 { 113 {
120 return I18n.format("gui.about.versiontext", this.modInfo.getVersion()); 114 return I18n.format("gui.about.versiontext", this.modInfo.getVersion());
121 } 115 }
122 116
123 - /**  
124 - * @return  
125 - */  
126 protected String getStatusText() 117 protected String getStatusText()
127 { 118 {
128 String statusText = this.isExternal ? I18n.format("gui.status.loaded") : I18n.format("gui.status.active"); 119 String statusText = this.isExternal ? I18n.format("gui.status.loaded") : I18n.format("gui.status.active");
java/client/com/mumfrey/liteloader/client/util/render/IconTiled.java
@@ -55,14 +55,6 @@ public class IconTiled implements Icon @@ -55,14 +55,6 @@ public class IconTiled implements Icon
55 this.init(iconU, iconV); 55 this.init(iconU, iconV);
56 } 56 }
57 57
58 - /**  
59 - * @param iconU  
60 - * @param iconV  
61 - * @param field_146120_f  
62 - * @param field_146121_g  
63 - * @param textureWidth  
64 - * @param textureHeight  
65 - */  
66 protected void init(int iconU, int iconV) 58 protected void init(int iconU, int iconV)
67 { 59 {
68 this.iconU = iconU; 60 this.iconU = iconU;
java/client/com/mumfrey/liteloader/util/ModUtilities.java
@@ -62,7 +62,7 @@ public abstract class ModUtilities @@ -62,7 +62,7 @@ public abstract class ModUtilities
62 } 62 }
63 63
64 /** 64 /**
65 - * @return 65 + * @return true if FML is present in the current environment
66 */ 66 */
67 public static boolean fmlIsPresent() 67 public static boolean fmlIsPresent()
68 { 68 {
@@ -235,7 +235,7 @@ public abstract class ModUtilities @@ -235,7 +235,7 @@ public abstract class ModUtilities
235 /** 235 /**
236 * Abstraction helper function 236 * Abstraction helper function
237 * 237 *
238 - * @param fieldName Name of field to get, returned unmodified if in debug mode 238 + * @param obf Field to get, returned unmodified if in debug mode
239 * @return Obfuscated field name if present 239 * @return Obfuscated field name if present
240 */ 240 */
241 public static String getObfuscatedFieldName(Obf obf) 241 public static String getObfuscatedFieldName(Obf obf)
java/common/com/mumfrey/liteloader/LiteMod.java
@@ -15,7 +15,7 @@ public interface LiteMod extends Exposable, Listener @@ -15,7 +15,7 @@ public interface LiteMod extends Exposable, Listener
15 /** 15 /**
16 * Get the mod version string 16 * Get the mod version string
17 * 17 *
18 - * @return 18 + * @return the mod version as a string
19 */ 19 */
20 public abstract String getVersion(); 20 public abstract String getVersion();
21 21
java/common/com/mumfrey/liteloader/api/ModInfoDecorator.java
@@ -26,7 +26,7 @@ public interface ModInfoDecorator extends CustomisationProvider @@ -26,7 +26,7 @@ public interface ModInfoDecorator extends CustomisationProvider
26 * Allows this decorator to modify the status text for the specified mod, return null if no modification required 26 * Allows this decorator to modify the status text for the specified mod, return null if no modification required
27 * 27 *
28 * @param statusText 28 * @param statusText
29 - * @return 29 + * @return new status text or NULL to indicate the text should remain default
30 */ 30 */
31 public abstract String modifyStatusText(ModInfo<?> mod, String statusText); 31 public abstract String modifyStatusText(ModInfo<?> mod, String statusText);
32 32
java/common/com/mumfrey/liteloader/api/manager/APIAdapter.java
@@ -62,13 +62,11 @@ public interface APIAdapter @@ -62,13 +62,11 @@ public interface APIAdapter
62 62
63 /** 63 /**
64 * @param api 64 * @param api
65 - * @return  
66 */ 65 */
67 public abstract List<? extends Observer> getPreInitObservers(LiteAPI api); 66 public abstract List<? extends Observer> getPreInitObservers(LiteAPI api);
68 67
69 /** 68 /**
70 * @param observerType 69 * @param observerType
71 - * @return  
72 */ 70 */
73 public abstract <T extends Observer> List<T> getPreInitObservers(Class<T> observerType); 71 public abstract <T extends Observer> List<T> getPreInitObservers(Class<T> observerType);
74 } 72 }
java/common/com/mumfrey/liteloader/api/manager/APIProvider.java
@@ -30,7 +30,6 @@ public interface APIProvider @@ -30,7 +30,6 @@ public interface APIProvider
30 * 30 *
31 * @param identifier API identifier (case sensitive) 31 * @param identifier API identifier (case sensitive)
32 * @param minRevision minimum required revision 32 * @param minRevision minimum required revision
33 - * @return  
34 */ 33 */
35 public abstract boolean isAPIAvailable(String identifier, int minRevision); 34 public abstract boolean isAPIAvailable(String identifier, int minRevision);
36 35
@@ -38,7 +37,6 @@ public interface APIProvider @@ -38,7 +37,6 @@ public interface APIProvider
38 * Gets a specific API by identifier 37 * Gets a specific API by identifier
39 * 38 *
40 * @param identifier API identifier (case sensitive) 39 * @param identifier API identifier (case sensitive)
41 - * @return  
42 */ 40 */
43 public abstract LiteAPI getAPI(String identifier); 41 public abstract LiteAPI getAPI(String identifier);
44 42
@@ -46,7 +44,6 @@ public interface APIProvider @@ -46,7 +44,6 @@ public interface APIProvider
46 * Gets a specific API by class 44 * Gets a specific API by class
47 * 45 *
48 * @param apiClass 46 * @param apiClass
49 - * @return  
50 */ 47 */
51 public abstract <T extends LiteAPI> T getAPI(Class<T> apiClass); 48 public abstract <T extends LiteAPI> T getAPI(Class<T> apiClass);
52 } 49 }
53 \ No newline at end of file 50 \ No newline at end of file
java/common/com/mumfrey/liteloader/api/manager/APIRegistry.java
@@ -62,7 +62,7 @@ public final class APIRegistry @@ -62,7 +62,7 @@ public final class APIRegistry
62 } 62 }
63 63
64 /** 64 /**
65 - * @return 65 + * Get all currently registered API classes
66 */ 66 */
67 public String[] getRegisteredAPIs() 67 public String[] getRegisteredAPIs()
68 { 68 {
@@ -133,8 +133,8 @@ public final class APIRegistry @@ -133,8 +133,8 @@ public final class APIRegistry
133 } 133 }
134 134
135 /** 135 /**
136 - * @return  
137 - * @throws InvalidAPIStateException 136 + * Bakes all currently registered API classes to a new APIProvider containing the API instances
  137 + * @throws InvalidAPIStateException if the API list was already baked
138 */ 138 */
139 public APIProvider bake() throws InvalidAPIStateException 139 public APIProvider bake() throws InvalidAPIStateException
140 { 140 {
@@ -148,8 +148,8 @@ public final class APIRegistry @@ -148,8 +148,8 @@ public final class APIRegistry
148 } 148 }
149 149
150 /** 150 /**
151 - * @return  
152 - * @throws InvalidAPIStateException 151 + * Gets the current APIProvider instance
  152 + * @throws InvalidAPIStateException if the provider list was not yet baked
153 */ 153 */
154 public APIProvider getProvider() throws InvalidAPIStateException 154 public APIProvider getProvider() throws InvalidAPIStateException
155 { 155 {
@@ -162,14 +162,14 @@ public final class APIRegistry @@ -162,14 +162,14 @@ public final class APIRegistry
162 } 162 }
163 163
164 /** 164 /**
165 - * @return  
166 - * @throws InvalidAPIStateException 165 + * Gets the current APIAdapter instance
  166 + * @throws InvalidAPIStateException if the provider list was not yet baked
167 */ 167 */
168 public APIAdapter getAdapter() throws InvalidAPIStateException 168 public APIAdapter getAdapter() throws InvalidAPIStateException
169 { 169 {
170 if (this.baked == null) 170 if (this.baked == null)
171 { 171 {
172 - throw new InvalidAPIStateException("Call to APIRegistry.getProvider() failed because the provider list has not been baked"); 172 + throw new InvalidAPIStateException("Call to APIRegistry.APIAdapter() failed because the provider list has not been baked");
173 } 173 }
174 174
175 return this.baked; 175 return this.baked;
java/common/com/mumfrey/liteloader/common/GameEngine.java
@@ -63,13 +63,11 @@ public interface GameEngine&lt;TClient, TServer extends MinecraftServer&gt; @@ -63,13 +63,11 @@ public interface GameEngine&lt;TClient, TServer extends MinecraftServer&gt;
63 63
64 /** 64 /**
65 * @param resourcePack 65 * @param resourcePack
66 - * @return  
67 */ 66 */
68 public abstract boolean registerResourcePack(IResourcePack resourcePack); 67 public abstract boolean registerResourcePack(IResourcePack resourcePack);
69 68
70 /** 69 /**
71 * @param resourcePack 70 * @param resourcePack
72 - * @return  
73 */ 71 */
74 public abstract boolean unRegisterResourcePack(IResourcePack resourcePack); 72 public abstract boolean unRegisterResourcePack(IResourcePack resourcePack);
75 73
java/common/com/mumfrey/liteloader/core/ClientPluginChannels.java
@@ -104,7 +104,6 @@ public abstract class ClientPluginChannels extends PluginChannels&lt;PluginChannelL @@ -104,7 +104,6 @@ public abstract class ClientPluginChannels extends PluginChannels&lt;PluginChannelL
104 /** 104 /**
105 * @param channel 105 * @param channel
106 * @param data 106 * @param data
107 - * @param length  
108 */ 107 */
109 protected void onModPacketReceived(String channel, PacketBuffer data) 108 protected void onModPacketReceived(String channel, PacketBuffer data)
110 { 109 {
java/common/com/mumfrey/liteloader/core/CommonPluginChannelListener.java
@@ -14,7 +14,7 @@ public interface CommonPluginChannelListener extends Listener @@ -14,7 +14,7 @@ public interface CommonPluginChannelListener extends Listener
14 /** 14 /**
15 * Return a list of the plugin channels the mod wants to register 15 * Return a list of the plugin channels the mod wants to register
16 * 16 *
17 - * @return 17 + * @return plugin channel names as a list, it is recommended to use {@link com.google.common.collect.ImmutableList#of} for this purpose
18 */ 18 */
19 public abstract List<String> getChannels(); 19 public abstract List<String> getChannels();
20 } 20 }
java/common/com/mumfrey/liteloader/core/EnabledModsList.java
@@ -55,7 +55,6 @@ public class EnabledModsList @@ -55,7 +55,6 @@ public class EnabledModsList
55 * 55 *
56 * @param profileName 56 * @param profileName
57 * @param identifier 57 * @param identifier
58 - * @return  
59 */ 58 */
60 public boolean isEnabled(String profileName, String identifier) 59 public boolean isEnabled(String profileName, String identifier)
61 { 60 {
@@ -143,8 +142,8 @@ public class EnabledModsList @@ -143,8 +142,8 @@ public class EnabledModsList
143 * Factory method which tries to deserialise the enablement list from the file or if failing creates 142 * Factory method which tries to deserialise the enablement list from the file or if failing creates
144 * and returns a new instance. 143 * and returns a new instance.
145 * 144 *
146 - * @param file  
147 - * @return 145 + * @param file JSON file to create the EnabledModsList from
  146 + * @return a new EnabledModsList instance
148 */ 147 */
149 public static EnabledModsList createFrom(File file) 148 public static EnabledModsList createFrom(File file)
150 { 149 {
java/common/com/mumfrey/liteloader/core/LiteLoader.java
@@ -256,10 +256,8 @@ public final class LiteLoader @@ -256,10 +256,8 @@ public final class LiteLoader
256 } 256 }
257 257
258 /** 258 /**
259 - * Get the singleton instance of LiteLoader, initialises the loader if  
260 - * necessary 259 + * Get the singleton instance of LiteLoader, initialises the loader if necessary
261 * 260 *
262 - * @param locationProvider  
263 * @return LiteLoader instance 261 * @return LiteLoader instance
264 */ 262 */
265 public static final LiteLoader getInstance() 263 public static final LiteLoader getInstance()
@@ -269,8 +267,6 @@ public final class LiteLoader @@ -269,8 +267,6 @@ public final class LiteLoader
269 267
270 /** 268 /**
271 * Get the tweak system classloader 269 * Get the tweak system classloader
272 - *  
273 - * @return  
274 */ 270 */
275 public static LaunchClassLoader getClassLoader() 271 public static LaunchClassLoader getClassLoader()
276 { 272 {
@@ -279,8 +275,6 @@ public final class LiteLoader @@ -279,8 +275,6 @@ public final class LiteLoader
279 275
280 /** 276 /**
281 * Get LiteLoader version 277 * Get LiteLoader version
282 - *  
283 - * @return  
284 */ 278 */
285 public static final String getVersion() 279 public static final String getVersion()
286 { 280 {
@@ -289,8 +283,6 @@ public final class LiteLoader @@ -289,8 +283,6 @@ public final class LiteLoader
289 283
290 /** 284 /**
291 * Get LiteLoader version 285 * Get LiteLoader version
292 - *  
293 - * @return  
294 */ 286 */
295 public static final String getVersionDisplayString() 287 public static final String getVersionDisplayString()
296 { 288 {
@@ -299,8 +291,6 @@ public final class LiteLoader @@ -299,8 +291,6 @@ public final class LiteLoader
299 291
300 /** 292 /**
301 * Get the loader revision 293 * Get the loader revision
302 - *  
303 - * @return  
304 */ 294 */
305 public static final int getRevision() 295 public static final int getRevision()
306 { 296 {
@@ -308,7 +298,7 @@ public final class LiteLoader @@ -308,7 +298,7 @@ public final class LiteLoader
308 } 298 }
309 299
310 /** 300 /**
311 - * @return 301 + * Get all active API instances
312 */ 302 */
313 public static final LiteAPI[] getAPIs() 303 public static final LiteAPI[] getAPIs()
314 { 304 {
@@ -319,14 +309,23 @@ public final class LiteLoader @@ -319,14 +309,23 @@ public final class LiteLoader
319 } 309 }
320 310
321 /** 311 /**
  312 + * Get an API instance by identifier (returns null if no instance matching the supplied identifier exists)
  313 + *
322 * @param identifier 314 * @param identifier
323 - * @return  
324 */ 315 */
325 public static final LiteAPI getAPI(String identifier) 316 public static final LiteAPI getAPI(String identifier)
326 { 317 {
327 return LiteLoader.instance.apiProvider.getAPI(identifier); 318 return LiteLoader.instance.apiProvider.getAPI(identifier);
328 } 319 }
329 320
  321 + /**
  322 + * @param identifier
  323 + */
  324 + public static boolean isAPIAvailable(String identifier)
  325 + {
  326 + return LiteLoader.getAPI(identifier) != null;
  327 + }
  328 +
330 @SuppressWarnings("unchecked") 329 @SuppressWarnings("unchecked")
331 public static final <C extends CustomisationProvider> C getCustomisationProvider(LiteAPI api, Class<C> providerType) 330 public static final <C extends CustomisationProvider> C getCustomisationProvider(LiteAPI api, Class<C> providerType)
332 { 331 {
@@ -339,33 +338,33 @@ public final class LiteLoader @@ -339,33 +338,33 @@ public final class LiteLoader
339 338
340 return null; 339 return null;
341 } 340 }
342 - 341 +
343 /** 342 /**
344 - * @param identifier  
345 - * @return 343 + * Get the client-side permissions manager
346 */ 344 */
347 - public static boolean isAPIAvailable(String identifier)  
348 - {  
349 - return LiteLoader.getAPI(identifier) != null;  
350 - }  
351 -  
352 public static PermissionsManagerClient getClientPermissionsManager() 345 public static PermissionsManagerClient getClientPermissionsManager()
353 { 346 {
354 return LiteLoader.instance.permissionsManagerClient; 347 return LiteLoader.instance.permissionsManagerClient;
355 } 348 }
356 349
  350 + /**
  351 + * Get the server-side permissions manager
  352 + */
357 public static PermissionsManagerServer getServerPermissionsManager() 353 public static PermissionsManagerServer getServerPermissionsManager()
358 { 354 {
359 return LiteLoader.instance.permissionsManagerServer; 355 return LiteLoader.instance.permissionsManagerServer;
360 } 356 }
361 357
  358 + /**
  359 + * Get the current game engine wrapper
  360 + */
362 public static GameEngine<?, ?> getGameEngine() 361 public static GameEngine<?, ?> getGameEngine()
363 { 362 {
364 return LiteLoader.instance.engine; 363 return LiteLoader.instance.engine;
365 } 364 }
366 365
367 /** 366 /**
368 - * @return 367 + * Get the interface manager
369 */ 368 */
370 public static LiteLoaderInterfaceManager getInterfaceManager() 369 public static LiteLoaderInterfaceManager getInterfaceManager()
371 { 370 {
@@ -374,8 +373,6 @@ public final class LiteLoader @@ -374,8 +373,6 @@ public final class LiteLoader
374 373
375 /** 374 /**
376 * Get the client-side plugin channel manager 375 * Get the client-side plugin channel manager
377 - *  
378 - * @return  
379 */ 376 */
380 public static ClientPluginChannels getClientPluginChannels() 377 public static ClientPluginChannels getClientPluginChannels()
381 { 378 {
@@ -384,8 +381,6 @@ public final class LiteLoader @@ -384,8 +381,6 @@ public final class LiteLoader
384 381
385 /** 382 /**
386 * Get the server-side plugin channel manager 383 * Get the server-side plugin channel manager
387 - *  
388 - * @return  
389 */ 384 */
390 public static ServerPluginChannels getServerPluginChannels() 385 public static ServerPluginChannels getServerPluginChannels()
391 { 386 {
@@ -402,8 +397,6 @@ public final class LiteLoader @@ -402,8 +397,6 @@ public final class LiteLoader
402 397
403 /** 398 /**
404 * Get the mod panel manager 399 * Get the mod panel manager
405 - *  
406 - * @return  
407 */ 400 */
408 @SuppressWarnings({ "cast", "unchecked" }) 401 @SuppressWarnings({ "cast", "unchecked" })
409 public static <T> PanelManager<T> getModPanelManager() 402 public static <T> PanelManager<T> getModPanelManager()
@@ -436,7 +429,7 @@ public final class LiteLoader @@ -436,7 +429,7 @@ public final class LiteLoader
436 } 429 }
437 430
438 /** 431 /**
439 - * @return 432 + * Get the game directory
440 */ 433 */
441 public static File getGameDirectory() 434 public static File getGameDirectory()
442 { 435 {
@@ -444,7 +437,7 @@ public final class LiteLoader @@ -444,7 +437,7 @@ public final class LiteLoader
444 } 437 }
445 438
446 /** 439 /**
447 - * @return 440 + * Get the "assets" root directory
448 */ 441 */
449 public static File getAssetsDirectory() 442 public static File getAssetsDirectory()
450 { 443 {
@@ -452,7 +445,7 @@ public final class LiteLoader @@ -452,7 +445,7 @@ public final class LiteLoader
452 } 445 }
453 446
454 /** 447 /**
455 - * @return 448 + * Get the name of the profile which launched the game
456 */ 449 */
457 public static String getProfile() 450 public static String getProfile()
458 { 451 {
@@ -470,13 +463,16 @@ public final class LiteLoader @@ -470,13 +463,16 @@ public final class LiteLoader
470 } 463 }
471 464
472 /** 465 /**
473 - * @return 466 + * Get whether the current environment is MCP
474 */ 467 */
475 public static boolean isDevelopmentEnvironment() 468 public static boolean isDevelopmentEnvironment()
476 { 469 {
477 return "true".equals(System.getProperty("mcpenv")); 470 return "true".equals(System.getProperty("mcpenv"));
478 } 471 }
479 472
  473 + /**
  474 + * Dump debugging information to the console
  475 + */
480 public static void dumpDebugInfo() 476 public static void dumpDebugInfo()
481 { 477 {
482 if (LiteLoaderLogger.DEBUG) 478 if (LiteLoaderLogger.DEBUG)
@@ -550,7 +546,6 @@ public final class LiteLoader @@ -550,7 +546,6 @@ public final class LiteLoader
550 * Get a reference to a loaded mod, if the mod exists 546 * Get a reference to a loaded mod, if the mod exists
551 * 547 *
552 * @param modName Mod's name, identifier or class name 548 * @param modName Mod's name, identifier or class name
553 - * @return  
554 * @throws InvalidActivityException 549 * @throws InvalidActivityException
555 */ 550 */
556 public <T extends LiteMod> T getMod(String modName) throws InvalidActivityException, IllegalArgumentException 551 public <T extends LiteMod> T getMod(String modName) throws InvalidActivityException, IllegalArgumentException
@@ -566,9 +561,7 @@ public final class LiteLoader @@ -566,9 +561,7 @@ public final class LiteLoader
566 /** 561 /**
567 * Get a reference to a loaded mod, if the mod exists 562 * Get a reference to a loaded mod, if the mod exists
568 * 563 *
569 - * @param modName Mod's name or class name  
570 - * @return  
571 - * @throws InvalidActivityException 564 + * @param modClass Mod class
572 */ 565 */
573 public <T extends LiteMod> T getMod(Class<T> modClass) 566 public <T extends LiteMod> T getMod(Class<T> modClass)
574 { 567 {
@@ -584,7 +577,6 @@ public final class LiteLoader @@ -584,7 +577,6 @@ public final class LiteLoader
584 * Get whether the specified mod is installed 577 * Get whether the specified mod is installed
585 * 578 *
586 * @param modName 579 * @param modName
587 - * @return  
588 */ 580 */
589 public boolean isModInstalled(String modName) 581 public boolean isModInstalled(String modName)
590 { 582 {
@@ -599,7 +591,6 @@ public final class LiteLoader @@ -599,7 +591,6 @@ public final class LiteLoader
599 * @param modNameOrId 591 * @param modNameOrId
600 * @param metaDataKey 592 * @param metaDataKey
601 * @param defaultValue 593 * @param defaultValue
602 - * @return  
603 * @throws InvalidActivityException Thrown by getMod if init is not complete 594 * @throws InvalidActivityException Thrown by getMod if init is not complete
604 * @throws IllegalArgumentException Thrown by getMod if argument is null 595 * @throws IllegalArgumentException Thrown by getMod if argument is null
605 */ 596 */
@@ -614,7 +605,6 @@ public final class LiteLoader @@ -614,7 +605,6 @@ public final class LiteLoader
614 * @param mod 605 * @param mod
615 * @param metaDataKey 606 * @param metaDataKey
616 * @param defaultValue 607 * @param defaultValue
617 - * @return  
618 */ 608 */
619 public String getModMetaData(LiteMod mod, String metaDataKey, String defaultValue) 609 public String getModMetaData(LiteMod mod, String metaDataKey, String defaultValue)
620 { 610 {
@@ -627,7 +617,6 @@ public final class LiteLoader @@ -627,7 +617,6 @@ public final class LiteLoader
627 * @param modClass 617 * @param modClass
628 * @param metaDataKey 618 * @param metaDataKey
629 * @param defaultValue 619 * @param defaultValue
630 - * @return  
631 */ 620 */
632 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue) 621 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue)
633 { 622 {
@@ -638,7 +627,6 @@ public final class LiteLoader @@ -638,7 +627,6 @@ public final class LiteLoader
638 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks 627 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks
639 * 628 *
640 * @param modClass 629 * @param modClass
641 - * @return  
642 */ 630 */
643 public String getModIdentifier(Class<? extends LiteMod> modClass) 631 public String getModIdentifier(Class<? extends LiteMod> modClass)
644 { 632 {
@@ -648,8 +636,7 @@ public final class LiteLoader @@ -648,8 +636,7 @@ public final class LiteLoader
648 /** 636 /**
649 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks 637 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks
650 * 638 *
651 - * @param modClass  
652 - * @return 639 + * @param mod
653 */ 640 */
654 public String getModIdentifier(LiteMod mod) 641 public String getModIdentifier(LiteMod mod)
655 { 642 {
@@ -660,7 +647,6 @@ public final class LiteLoader @@ -660,7 +647,6 @@ public final class LiteLoader
660 * Get the container (mod file, classpath jar or folder) for the specified mod 647 * Get the container (mod file, classpath jar or folder) for the specified mod
661 * 648 *
662 * @param modClass 649 * @param modClass
663 - * @return  
664 */ 650 */
665 public LoadableMod<?> getModContainer(Class<? extends LiteMod> modClass) 651 public LoadableMod<?> getModContainer(Class<? extends LiteMod> modClass)
666 { 652 {
@@ -670,8 +656,7 @@ public final class LiteLoader @@ -670,8 +656,7 @@ public final class LiteLoader
670 /** 656 /**
671 * Get the container (mod file, classpath jar or folder) for the specified mod 657 * Get the container (mod file, classpath jar or folder) for the specified mod
672 * 658 *
673 - * @param modClass  
674 - * @return 659 + * @param mod
675 */ 660 */
676 public LoadableMod<?> getModContainer(LiteMod mod) 661 public LoadableMod<?> getModContainer(LiteMod mod)
677 { 662 {
@@ -682,7 +667,6 @@ public final class LiteLoader @@ -682,7 +667,6 @@ public final class LiteLoader
682 * Get the mod which matches the specified identifier 667 * Get the mod which matches the specified identifier
683 * 668 *
684 * @param identifier 669 * @param identifier
685 - * @return  
686 */ 670 */
687 public Class<? extends LiteMod> getModFromIdentifier(String identifier) 671 public Class<? extends LiteMod> getModFromIdentifier(String identifier)
688 { 672 {
@@ -716,7 +700,6 @@ public final class LiteLoader @@ -716,7 +700,6 @@ public final class LiteLoader
716 700
717 /** 701 /**
718 * @param modName 702 * @param modName
719 - * @return  
720 */ 703 */
721 public boolean isModEnabled(String modName) 704 public boolean isModEnabled(String modName)
722 { 705 {
@@ -725,7 +708,6 @@ public final class LiteLoader @@ -725,7 +708,6 @@ public final class LiteLoader
725 708
726 /** 709 /**
727 * @param modName 710 * @param modName
728 - * @return  
729 */ 711 */
730 public boolean isModActive(String modName) 712 public boolean isModActive(String modName)
731 { 713 {
java/common/com/mumfrey/liteloader/core/LiteLoaderBootstrap.java
@@ -182,7 +182,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -182,7 +182,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
182 182
183 /** 183 /**
184 * @param version 184 * @param version
185 - * @return  
186 */ 185 */
187 @Override 186 @Override
188 public File inflectVersionedConfigPath(LiteLoaderVersion version) 187 public File inflectVersionedConfigPath(LiteLoaderVersion version)
@@ -196,7 +195,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -196,7 +195,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
196 } 195 }
197 196
198 /** 197 /**
199 - * @return  
200 * 198 *
201 */ 199 */
202 private void initAPIs(List<String> apisToLoad) 200 private void initAPIs(List<String> apisToLoad)
@@ -301,8 +299,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -301,8 +299,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
301 299
302 /** 300 /**
303 * @param classLoader 301 * @param classLoader
304 - * @param loadTweaks  
305 - * @return  
306 */ 302 */
307 protected LiteLoaderEnumerator spawnEnumerator(LaunchClassLoader classLoader) 303 protected LiteLoaderEnumerator spawnEnumerator(LaunchClassLoader classLoader)
308 { 304 {
@@ -531,7 +527,7 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -531,7 +527,7 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
531 } 527 }
532 528
533 /** 529 /**
534 - * @return 530 + * Get the common configuration folder
535 */ 531 */
536 @Override 532 @Override
537 public File getCommonConfigFolder() 533 public File getCommonConfigFolder()
@@ -540,7 +536,7 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -540,7 +536,7 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
540 } 536 }
541 537
542 /** 538 /**
543 - * @return 539 + * Get the versioned configuration folder
544 */ 540 */
545 @Override 541 @Override
546 public File getVersionedConfigFolder() 542 public File getVersionedConfigFolder()
@@ -553,7 +549,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -553,7 +549,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
553 * 549 *
554 * @param propertyName 550 * @param propertyName
555 * @param defaultValue 551 * @param defaultValue
556 - * @return  
557 */ 552 */
558 @Override 553 @Override
559 public boolean getAndStoreBooleanProperty(String propertyName, boolean defaultValue) 554 public boolean getAndStoreBooleanProperty(String propertyName, boolean defaultValue)
@@ -567,8 +562,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -567,8 +562,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
567 * Get a boolean propery from the properties file and also write the new value back to the properties file 562 * Get a boolean propery from the properties file and also write the new value back to the properties file
568 * 563 *
569 * @param propertyName 564 * @param propertyName
570 - * @param defaultValue  
571 - * @return  
572 */ 565 */
573 @Override 566 @Override
574 public boolean getBooleanProperty(String propertyName) 567 public boolean getBooleanProperty(String propertyName)
@@ -627,7 +620,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -627,7 +620,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
627 * Get last know revision for mod from the config file 620 * Get last know revision for mod from the config file
628 * 621 *
629 * @param modKey 622 * @param modKey
630 - * @return  
631 */ 623 */
632 @Override 624 @Override
633 public int getLastKnownModRevision(String modKey) 625 public int getLastKnownModRevision(String modKey)
@@ -707,12 +699,18 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP @@ -707,12 +699,18 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
707 } 699 }
708 } 700 }
709 701
  702 + /* (non-Javadoc)
  703 + * @see com.mumfrey.liteloader.launch.LoaderBootstrap#getRequiredTransformers()
  704 + */
710 @Override 705 @Override
711 public List<String> getRequiredTransformers() 706 public List<String> getRequiredTransformers()
712 { 707 {
713 return this.apiAdapter.getRequiredTransformers(); 708 return this.apiAdapter.getRequiredTransformers();
714 } 709 }
715 710
  711 + /* (non-Javadoc)
  712 + * @see com.mumfrey.liteloader.launch.LoaderBootstrap#getRequiredDownstreamTransformers()
  713 + */
716 @Override 714 @Override
717 public List<String> getRequiredDownstreamTransformers() 715 public List<String> getRequiredDownstreamTransformers()
718 { 716 {
java/common/com/mumfrey/liteloader/core/LiteLoaderEnumerator.java
@@ -122,10 +122,9 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -122,10 +122,9 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
122 protected EnumeratorState state = EnumeratorState.INIT; 122 protected EnumeratorState state = EnumeratorState.INIT;
123 123
124 /** 124 /**
  125 + * @param environment
125 * @param properties 126 * @param properties
126 * @param classLoader 127 * @param classLoader
127 - * @param loadTweaks  
128 - * @param gameFolder  
129 */ 128 */
130 public LiteLoaderEnumerator(LoaderEnvironment environment, LoaderProperties properties, LaunchClassLoader classLoader) 129 public LiteLoaderEnumerator(LoaderEnvironment environment, LoaderProperties properties, LaunchClassLoader classLoader)
131 { 130 {
@@ -190,7 +189,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -190,7 +189,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
190 } 189 }
191 190
192 /** 191 /**
193 - * @return 192 + * Get the loader environment
194 */ 193 */
195 public LoaderEnvironment getEnvironment() 194 public LoaderEnvironment getEnvironment()
196 { 195 {
@@ -199,7 +198,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -199,7 +198,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
199 198
200 /** 199 /**
201 * Initialise the "shared" mod list if it's not already been created 200 * Initialise the "shared" mod list if it's not already been created
202 - * @return  
203 */ 201 */
204 @Override 202 @Override
205 public Map<String, Map<String, String>> getSharedModList() 203 public Map<String, Map<String, String>> getSharedModList()
@@ -252,7 +250,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -252,7 +250,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
252 } 250 }
253 251
254 /** 252 /**
255 - * @return 253 + * Get the set of disabled containers
256 */ 254 */
257 @Override 255 @Override
258 public Collection<? extends ModInfo<Loadable<?>>> getDisabledContainers() 256 public Collection<? extends ModInfo<Loadable<?>>> getDisabledContainers()
@@ -285,10 +283,9 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -285,10 +283,9 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
285 /** 283 /**
286 * Get a metadata value for the specified mod 284 * Get a metadata value for the specified mod
287 * 285 *
288 - * @param modClassName 286 + * @param modClass
289 * @param metaDataKey 287 * @param metaDataKey
290 * @param defaultValue 288 * @param defaultValue
291 - * @return  
292 */ 289 */
293 @Override 290 @Override
294 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue) 291 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue)
@@ -299,8 +296,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -299,8 +296,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
299 } 296 }
300 297
301 /** 298 /**
302 - * @param mod  
303 - * @return 299 + * @param identifier
304 */ 300 */
305 @Override 301 @Override
306 public LoadableMod<?> getContainer(String identifier) 302 public LoadableMod<?> getContainer(String identifier)
@@ -321,8 +317,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -321,8 +317,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
321 } 317 }
322 318
323 /** 319 /**
324 - * @param mod  
325 - * @return 320 + * @param modClass
326 */ 321 */
327 @Override 322 @Override
328 public LoadableMod<?> getContainer(Class<? extends LiteMod> modClass) 323 public LoadableMod<?> getContainer(Class<? extends LiteMod> modClass)
@@ -351,7 +346,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator @@ -351,7 +346,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
351 * Get the mod identifier (metadata key), this is used for versioning, exclusivity, and enablement checks 346 * Get the mod identifier (metadata key), this is used for versioning, exclusivity, and enablement checks
352 * 347 *
353 * @param modClass 348 * @param modClass
354 - * @return  
355 */ 349 */
356 @Override 350 @Override
357 public String getIdentifier(Class<? extends LiteMod> modClass) 351 public String getIdentifier(Class<? extends LiteMod> modClass)
java/common/com/mumfrey/liteloader/core/LiteLoaderEventBroker.java
@@ -99,10 +99,11 @@ public abstract class LiteLoaderEventBroker&lt;TClient, TServer extends MinecraftSe @@ -99,10 +99,11 @@ public abstract class LiteLoaderEventBroker&lt;TClient, TServer extends MinecraftSe
99 private FastIterable<ServerPlayerListener> serverPlayerListeners = new HandlerList<ServerPlayerListener>(ServerPlayerListener.class); 99 private FastIterable<ServerPlayerListener> serverPlayerListeners = new HandlerList<ServerPlayerListener>(ServerPlayerListener.class);
100 100
101 /** 101 /**
102 - * Package private ctor 102 + * ctor
103 * 103 *
104 * @param loader 104 * @param loader
105 - * @param minecraft 105 + * @param engine
  106 + * @param properties
106 */ 107 */
107 public LiteLoaderEventBroker(LiteLoader loader, GameEngine<TClient, TServer> engine, LoaderProperties properties) 108 public LiteLoaderEventBroker(LiteLoader loader, GameEngine<TClient, TServer> engine, LoaderProperties properties)
108 { 109 {
@@ -241,7 +242,7 @@ public abstract class LiteLoaderEventBroker&lt;TClient, TServer extends MinecraftSe @@ -241,7 +242,7 @@ public abstract class LiteLoaderEventBroker&lt;TClient, TServer extends MinecraftSe
241 * @param player 242 * @param player
242 * @param oldPlayer 243 * @param oldPlayer
243 * @param dimension 244 * @param dimension
244 - * @param copy 245 + * @param won
245 */ 246 */
246 public void onRespawnPlayer(ServerConfigurationManager scm, EntityPlayerMP player, EntityPlayerMP oldPlayer, int dimension, boolean won) 247 public void onRespawnPlayer(ServerConfigurationManager scm, EntityPlayerMP player, EntityPlayerMP oldPlayer, int dimension, boolean won)
247 { 248 {
java/common/com/mumfrey/liteloader/core/LiteLoaderInterfaceManager.java
@@ -239,7 +239,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry @@ -239,7 +239,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry
239 239
240 /** 240 /**
241 * @param api 241 * @param api
242 - * @param observers  
243 */ 242 */
244 @Override 243 @Override
245 public void registerAPI(LiteAPI api) 244 public void registerAPI(LiteAPI api)
@@ -275,7 +274,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry @@ -275,7 +274,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry
275 * Register a new interface provider 274 * Register a new interface provider
276 * 275 *
277 * @param provider 276 * @param provider
278 - * @return  
279 */ 277 */
280 public boolean registerProvider(InterfaceProvider provider) 278 public boolean registerProvider(InterfaceProvider provider)
281 { 279 {
@@ -382,7 +380,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry @@ -382,7 +380,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry
382 380
383 /** 381 /**
384 * @param interfaceType 382 * @param interfaceType
385 - * @return  
386 */ 383 */
387 public List<InterfaceProvider> getProvidersFor(Class<? extends Listener> interfaceType) 384 public List<InterfaceProvider> getProvidersFor(Class<? extends Listener> interfaceType)
388 { 385 {
@@ -433,7 +430,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry @@ -433,7 +430,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry
433 * returns null 430 * returns null
434 * 431 *
435 * @param provider 432 * @param provider
436 - * @return  
437 */ 433 */
438 public LiteAPI getAPIForProvider(InterfaceProvider provider) 434 public LiteAPI getAPIForProvider(InterfaceProvider provider)
439 { 435 {
java/common/com/mumfrey/liteloader/core/LiteLoaderMods.java
@@ -192,7 +192,6 @@ public class LiteLoaderMods @@ -192,7 +192,6 @@ public class LiteLoaderMods
192 * Get whether the specified mod is installed 192 * Get whether the specified mod is installed
193 * 193 *
194 * @param modName 194 * @param modName
195 - * @return  
196 */ 195 */
197 public boolean isModInstalled(String modName) 196 public boolean isModInstalled(String modName)
198 { 197 {
@@ -210,7 +209,6 @@ public class LiteLoaderMods @@ -210,7 +209,6 @@ public class LiteLoaderMods
210 * Get a reference to a loaded mod, if the mod exists 209 * Get a reference to a loaded mod, if the mod exists
211 * 210 *
212 * @param modName Mod's name, identifier or class name 211 * @param modName Mod's name, identifier or class name
213 - * @return  
214 */ 212 */
215 @SuppressWarnings("unchecked") 213 @SuppressWarnings("unchecked")
216 public <T extends LiteMod> T getMod(String modName) 214 public <T extends LiteMod> T getMod(String modName)
@@ -232,8 +230,7 @@ public class LiteLoaderMods @@ -232,8 +230,7 @@ public class LiteLoaderMods
232 /** 230 /**
233 * Get a reference to a loaded mod, if the mod exists 231 * Get a reference to a loaded mod, if the mod exists
234 * 232 *
235 - * @param modName Mod's name or class name  
236 - * @return 233 + * @param modClass Mod class
237 */ 234 */
238 @SuppressWarnings("unchecked") 235 @SuppressWarnings("unchecked")
239 public <T extends LiteMod> T getMod(Class<T> modClass) 236 public <T extends LiteMod> T getMod(Class<T> modClass)
@@ -251,7 +248,6 @@ public class LiteLoaderMods @@ -251,7 +248,6 @@ public class LiteLoaderMods
251 * Get the mod which matches the specified identifier 248 * Get the mod which matches the specified identifier
252 * 249 *
253 * @param identifier 250 * @param identifier
254 - * @return  
255 */ 251 */
256 public Class<? extends LiteMod> getModFromIdentifier(String identifier) 252 public Class<? extends LiteMod> getModFromIdentifier(String identifier)
257 { 253 {
@@ -272,7 +268,6 @@ public class LiteLoaderMods @@ -272,7 +268,6 @@ public class LiteLoaderMods
272 * @param modNameOrId 268 * @param modNameOrId
273 * @param metaDataKey 269 * @param metaDataKey
274 * @param defaultValue 270 * @param defaultValue
275 - * @return  
276 * @throws InvalidActivityException Thrown by getMod if init is not complete 271 * @throws InvalidActivityException Thrown by getMod if init is not complete
277 * @throws IllegalArgumentException Thrown by getMod if argument is null 272 * @throws IllegalArgumentException Thrown by getMod if argument is null
278 */ 273 */
@@ -287,7 +282,6 @@ public class LiteLoaderMods @@ -287,7 +282,6 @@ public class LiteLoaderMods
287 * @param mod 282 * @param mod
288 * @param metaDataKey 283 * @param metaDataKey
289 * @param defaultValue 284 * @param defaultValue
290 - * @return  
291 */ 285 */
292 public String getModMetaData(LiteMod mod, String metaDataKey, String defaultValue) 286 public String getModMetaData(LiteMod mod, String metaDataKey, String defaultValue)
293 { 287 {
@@ -301,7 +295,6 @@ public class LiteLoaderMods @@ -301,7 +295,6 @@ public class LiteLoaderMods
301 * @param modClass 295 * @param modClass
302 * @param metaDataKey 296 * @param metaDataKey
303 * @param defaultValue 297 * @param defaultValue
304 - * @return  
305 */ 298 */
306 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue) 299 public String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue)
307 { 300 {
@@ -313,7 +306,6 @@ public class LiteLoaderMods @@ -313,7 +306,6 @@ public class LiteLoaderMods
313 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks 306 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks
314 * 307 *
315 * @param modClass 308 * @param modClass
316 - * @return  
317 */ 309 */
318 public String getModIdentifier(Class<? extends LiteMod> modClass) 310 public String getModIdentifier(Class<? extends LiteMod> modClass)
319 { 311 {
@@ -323,8 +315,7 @@ public class LiteLoaderMods @@ -323,8 +315,7 @@ public class LiteLoaderMods
323 /** 315 /**
324 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks 316 * Get the mod identifier, this is used for versioning, exclusivity, and enablement checks
325 * 317 *
326 - * @param modClass  
327 - * @return 318 + * @param mod
328 */ 319 */
329 public String getModIdentifier(LiteMod mod) 320 public String getModIdentifier(LiteMod mod)
330 { 321 {
@@ -335,7 +326,6 @@ public class LiteLoaderMods @@ -335,7 +326,6 @@ public class LiteLoaderMods
335 * Get the container (mod file, classpath jar or folder) for the specified mod 326 * Get the container (mod file, classpath jar or folder) for the specified mod
336 * 327 *
337 * @param modClass 328 * @param modClass
338 - * @return  
339 */ 329 */
340 public LoadableMod<?> getModContainer(Class<? extends LiteMod> modClass) 330 public LoadableMod<?> getModContainer(Class<? extends LiteMod> modClass)
341 { 331 {
@@ -345,8 +335,7 @@ public class LiteLoaderMods @@ -345,8 +335,7 @@ public class LiteLoaderMods
345 /** 335 /**
346 * Get the container (mod file, classpath jar or folder) for the specified mod 336 * Get the container (mod file, classpath jar or folder) for the specified mod
347 * 337 *
348 - * @param modClass  
349 - * @return 338 + * @param mod
350 */ 339 */
351 public LoadableMod<?> getModContainer(LiteMod mod) 340 public LoadableMod<?> getModContainer(LiteMod mod)
352 { 341 {
@@ -381,7 +370,6 @@ public class LiteLoaderMods @@ -381,7 +370,6 @@ public class LiteLoaderMods
381 370
382 /** 371 /**
383 * @param identifier 372 * @param identifier
384 - * @return  
385 */ 373 */
386 public boolean isModEnabled(String identifier) 374 public boolean isModEnabled(String identifier)
387 { 375 {
@@ -394,8 +382,7 @@ public class LiteLoaderMods @@ -394,8 +382,7 @@ public class LiteLoaderMods
394 } 382 }
395 383
396 /** 384 /**
397 - * @param modName  
398 - * @return 385 + * @param identifier
399 */ 386 */
400 public boolean isModActive(String identifier) 387 public boolean isModActive(String identifier)
401 { 388 {
java/common/com/mumfrey/liteloader/core/Mod.java
@@ -166,7 +166,6 @@ class Mod extends ModInfo&lt;LoadableMod&lt;?&gt;&gt; @@ -166,7 +166,6 @@ class Mod extends ModInfo&lt;LoadableMod&lt;?&gt;&gt;
166 * Get whether any of the valid identifiers match the supplied name 166 * Get whether any of the valid identifiers match the supplied name
167 * 167 *
168 * @param name 168 * @param name
169 - * @return  
170 */ 169 */
171 public boolean matchesName(String name) 170 public boolean matchesName(String name)
172 { 171 {
@@ -177,7 +176,6 @@ class Mod extends ModInfo&lt;LoadableMod&lt;?&gt;&gt; @@ -177,7 +176,6 @@ class Mod extends ModInfo&lt;LoadableMod&lt;?&gt;&gt;
177 * Get whether ths mod identifier matches the supplied identifier 176 * Get whether ths mod identifier matches the supplied identifier
178 * 177 *
179 * @param identifier 178 * @param identifier
180 - * @return  
181 */ 179 */
182 public boolean matchesIdentifier(String identifier) 180 public boolean matchesIdentifier(String identifier)
183 { 181 {
java/common/com/mumfrey/liteloader/core/PacketEvents.java
@@ -141,9 +141,7 @@ public abstract class PacketEvents implements InterfaceProvider @@ -141,9 +141,7 @@ public abstract class PacketEvents implements InterfaceProvider
141 } 141 }
142 142
143 /** 143 /**
144 - *  
145 * @param context 144 * @param context
146 - * @return  
147 */ 145 */
148 protected abstract IThreadListener getPacketContextListener(Packets.Context context); 146 protected abstract IThreadListener getPacketContextListener(Packets.Context context);
149 147
@@ -151,7 +149,6 @@ public abstract class PacketEvents implements InterfaceProvider @@ -151,7 +149,6 @@ public abstract class PacketEvents implements InterfaceProvider
151 * @param e 149 * @param e
152 * @param netHandler 150 * @param netHandler
153 * @param packetId 151 * @param packetId
154 - * @param packet  
155 * 152 *
156 * @return true if the packet was handled by a local handler and shouldn't be forwarded to later handlers 153 * @return true if the packet was handled by a local handler and shouldn't be forwarded to later handlers
157 */ 154 */
java/common/com/mumfrey/liteloader/core/PluginChannels.java
@@ -63,7 +63,7 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl @@ -63,7 +63,7 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl
63 } 63 }
64 64
65 /** 65 /**
66 - * @return 66 + * Spawn the handler list instance for this channel manager
67 */ 67 */
68 protected abstract FastIterableDeque<L> createHandlerList(); 68 protected abstract FastIterableDeque<L> createHandlerList();
69 69
@@ -87,7 +87,7 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl @@ -87,7 +87,7 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl
87 * Check whether a server plugin channel is registered 87 * Check whether a server plugin channel is registered
88 * 88 *
89 * @param channel 89 * @param channel
90 - * @return 90 + * @return true if the channel is registered at the server side
91 */ 91 */
92 public boolean isRemoteChannelRegistered(String channel) 92 public boolean isRemoteChannelRegistered(String channel)
93 { 93 {
@@ -136,7 +136,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl @@ -136,7 +136,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl
136 } 136 }
137 137
138 /** 138 /**
139 - * @return  
140 * 139 *
141 */ 140 */
142 protected PacketBuffer getRegistrationData() 141 protected PacketBuffer getRegistrationData()
@@ -215,7 +214,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl @@ -215,7 +214,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl
215 * True if this policy allows outbound traffic on the specified channel 214 * True if this policy allows outbound traffic on the specified channel
216 * 215 *
217 * @param channel 216 * @param channel
218 - * @return  
219 */ 217 */
220 public boolean allows(PluginChannels<?> channels, String channel) 218 public boolean allows(PluginChannels<?> channels, String channel)
221 { 219 {
@@ -225,8 +223,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl @@ -225,8 +223,6 @@ public abstract class PluginChannels&lt;L extends CommonPluginChannelListener&gt; impl
225 223
226 /** 224 /**
227 * True if this policy does not throw an exception for unregistered outbound channels 225 * True if this policy does not throw an exception for unregistered outbound channels
228 - *  
229 - * @return  
230 */ 226 */
231 public boolean isSilent() 227 public boolean isSilent()
232 { 228 {
java/common/com/mumfrey/liteloader/core/ServerPluginChannels.java
@@ -141,9 +141,9 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList @@ -141,9 +141,9 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList
141 } 141 }
142 142
143 /** 143 /**
  144 + * @param sender
144 * @param channel 145 * @param channel
145 * @param data 146 * @param data
146 - * @param length  
147 */ 147 */
148 protected void onModPacketReceived(EntityPlayerMP sender, String channel, PacketBuffer data) 148 protected void onModPacketReceived(EntityPlayerMP sender, String channel, PacketBuffer data)
149 { 149 {
java/common/com/mumfrey/liteloader/core/api/EnumeratorModuleClassPath.java
@@ -33,12 +33,6 @@ public class EnumeratorModuleClassPath implements EnumeratorModule @@ -33,12 +33,6 @@ public class EnumeratorModuleClassPath implements EnumeratorModule
33 33
34 private boolean loadTweaks; 34 private boolean loadTweaks;
35 35
36 - /**  
37 - * @param parent  
38 - * @param searchProtectionDomain  
39 - * @param searchClassPath  
40 - * @param loadTweaks  
41 - */  
42 public EnumeratorModuleClassPath() 36 public EnumeratorModuleClassPath()
43 { 37 {
44 // Read the JVM class path into the local array 38 // Read the JVM class path into the local array
java/common/com/mumfrey/liteloader/core/api/EnumeratorModuleFolder.java
@@ -83,6 +83,9 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule @@ -83,6 +83,9 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
83 properties.setBooleanProperty(LoaderProperties.OPTION_SEARCH_JARFILES, this.readJarFiles); 83 properties.setBooleanProperty(LoaderProperties.OPTION_SEARCH_JARFILES, this.readJarFiles);
84 } 84 }
85 85
  86 + /* (non-Javadoc)
  87 + * @see java.lang.Object#toString()
  88 + */
86 @Override 89 @Override
87 public String toString() 90 public String toString()
88 { 91 {
@@ -90,7 +93,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule @@ -90,7 +93,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
90 } 93 }
91 94
92 /** 95 /**
93 - * @return 96 + * Get the directory this module will inspect
94 */ 97 */
95 public File getDirectory() 98 public File getDirectory()
96 { 99 {
@@ -202,7 +205,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule @@ -202,7 +205,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
202 } 205 }
203 206
204 /** 207 /**
205 - * @return 208 + * Get the {@link FilenameFilter} to use to filter candidate files
206 */ 209 */
207 protected FilenameFilter getFilenameFilter() 210 protected FilenameFilter getFilenameFilter()
208 { 211 {
@@ -212,7 +215,6 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule @@ -212,7 +215,6 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
212 215
213 /** 216 /**
214 * @param modFile 217 * @param modFile
215 - * @return  
216 */ 218 */
217 protected boolean isFileSupported(LoadableModFile modFile) 219 protected boolean isFileSupported(LoadableModFile modFile)
218 { 220 {
java/common/com/mumfrey/liteloader/core/api/EnumeratorModuleProtectionDomain.java
@@ -22,12 +22,6 @@ public class EnumeratorModuleProtectionDomain implements EnumeratorModule @@ -22,12 +22,6 @@ public class EnumeratorModuleProtectionDomain implements EnumeratorModule
22 { 22 {
23 private LoadableMod<File> codeSource; 23 private LoadableMod<File> codeSource;
24 24
25 - /**  
26 - * @param parent  
27 - * @param searchProtectionDomain  
28 - * @param searchClassPath  
29 - * @param loadTweaks  
30 - */  
31 public EnumeratorModuleProtectionDomain(boolean loadTweaks) 25 public EnumeratorModuleProtectionDomain(boolean loadTweaks)
32 { 26 {
33 this.initPackagePath(); 27 this.initPackagePath();
java/common/com/mumfrey/liteloader/core/api/LiteLoaderCoreAPI.java
@@ -148,7 +148,7 @@ public abstract class LiteLoaderCoreAPI implements LiteAPI @@ -148,7 +148,7 @@ public abstract class LiteLoaderCoreAPI implements LiteAPI
148 } 148 }
149 149
150 /** 150 /**
151 - * @return 151 + * Get the ObjectFactory
152 */ 152 */
153 public abstract ObjectFactory<?, ?> getObjectFactory(); 153 public abstract ObjectFactory<?, ?> getObjectFactory();
154 } 154 }
java/common/com/mumfrey/liteloader/core/api/LoadableModFile.java
@@ -384,12 +384,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt; @@ -384,12 +384,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
384 } 384 }
385 } 385 }
386 386
387 - /**  
388 - * Registers this file as a minecraft resource pack  
389 - *  
390 - * @param name  
391 - * @return true if the pack was added  
392 - */  
393 @Override 387 @Override
394 public boolean hasResourcePack() 388 public boolean hasResourcePack()
395 { 389 {
@@ -490,16 +484,12 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt; @@ -490,16 +484,12 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
490 /** 484 /**
491 * @param name 485 * @param name
492 * @param charset 486 * @param charset
493 - * @return  
494 */ 487 */
495 public String getFileContents(String name, Charset charset) 488 public String getFileContents(String name, Charset charset)
496 { 489 {
497 return LoadableModFile.getFileContents(this, name, charset); 490 return LoadableModFile.getFileContents(this, name, charset);
498 } 491 }
499 492
500 - /**  
501 - * @return  
502 - */  
503 protected static List<String> enumerateZipFile(File file) 493 protected static List<String> enumerateZipFile(File file)
504 { 494 {
505 List<String> classes = new ArrayList<String>(); 495 List<String> classes = new ArrayList<String>();
@@ -572,7 +562,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt; @@ -572,7 +562,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
572 /** 562 /**
573 * @param zip 563 * @param zip
574 * @param entry 564 * @param entry
575 - * @return  
576 * @throws IOException 565 * @throws IOException
577 */ 566 */
578 public static String zipEntryToString(ZipFile zip, ZipEntry entry) throws IOException 567 public static String zipEntryToString(ZipFile zip, ZipEntry entry) throws IOException
@@ -616,7 +605,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt; @@ -616,7 +605,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
616 * @param parent 605 * @param parent
617 * @param name 606 * @param name
618 * @param charset 607 * @param charset
619 - * @return  
620 */ 608 */
621 public static String getFileContents(File parent, String name, Charset charset) 609 public static String getFileContents(File parent, String name, Charset charset)
622 { 610 {
java/common/com/mumfrey/liteloader/core/event/HandlerList.java
@@ -217,10 +217,8 @@ public class HandlerList&lt;T&gt; extends LinkedList&lt;T&gt; implements FastIterableDeque&lt;T @@ -217,10 +217,8 @@ public class HandlerList&lt;T&gt; extends LinkedList&lt;T&gt; implements FastIterableDeque&lt;T
217 return 1000; 217 return 1000;
218 } 218 }
219 219
220 - /**  
221 - * Returns the baked list of all listeners  
222 - *  
223 - * @return 220 + /* (non-Javadoc)
  221 + * @see com.mumfrey.liteloader.interfaces.FastIterable#all()
224 */ 222 */
225 @Override 223 @Override
226 public T all() 224 public T all()
java/common/com/mumfrey/liteloader/core/runtime/Obf.java
@@ -165,7 +165,6 @@ public class Obf @@ -165,7 +165,6 @@ public class Obf
165 } 165 }
166 166
167 /** 167 /**
168 - * @param mcpName  
169 * @param seargeName 168 * @param seargeName
170 * @param obfName 169 * @param obfName
171 */ 170 */
@@ -191,7 +190,6 @@ public class Obf @@ -191,7 +190,6 @@ public class Obf
191 190
192 /** 191 /**
193 * @param type 192 * @param type
194 - * @return  
195 */ 193 */
196 public String getDescriptor(int type) 194 public String getDescriptor(int type)
197 { 195 {
@@ -200,7 +198,6 @@ public class Obf @@ -200,7 +198,6 @@ public class Obf
200 198
201 /** 199 /**
202 * @param seargeName 200 * @param seargeName
203 - * @return  
204 */ 201 */
205 protected String getDeobfuscatedName(String seargeName) 202 protected String getDeobfuscatedName(String seargeName)
206 { 203 {
@@ -209,7 +206,6 @@ public class Obf @@ -209,7 +206,6 @@ public class Obf
209 206
210 /** 207 /**
211 * @param seargeName 208 * @param seargeName
212 - * @return  
213 */ 209 */
214 static String getDeobfName(String seargeName) 210 static String getDeobfName(String seargeName)
215 { 211 {
@@ -238,7 +234,6 @@ public class Obf @@ -238,7 +234,6 @@ public class Obf
238 234
239 /** 235 /**
240 * @param name 236 * @param name
241 - * @return  
242 */ 237 */
243 public static Obf getByName(String name) 238 public static Obf getByName(String name)
244 { 239 {
java/common/com/mumfrey/liteloader/core/runtime/Packets.java
@@ -303,7 +303,6 @@ public class Packets extends Obf @@ -303,7 +303,6 @@ public class Packets extends Obf
303 303
304 /** 304 /**
305 * @param name 305 * @param name
306 - * @return  
307 */ 306 */
308 public static Packets getByName(String name) 307 public static Packets getByName(String name)
309 { 308 {
java/common/com/mumfrey/liteloader/crashreport/CallableLaunchWrapper.java
@@ -26,7 +26,7 @@ public class CallableLaunchWrapper implements Callable&lt;String&gt; @@ -26,7 +26,7 @@ public class CallableLaunchWrapper implements Callable&lt;String&gt;
26 } 26 }
27 27
28 /** 28 /**
29 - * @return 29 + * Generates a list of active transformers to display in the crash report
30 */ 30 */
31 public static String generateTransformerList() 31 public static String generateTransformerList()
32 { 32 {
java/common/com/mumfrey/liteloader/interfaces/FastIterable.java
@@ -18,8 +18,6 @@ public interface FastIterable&lt;T&gt; @@ -18,8 +18,6 @@ public interface FastIterable&lt;T&gt;
18 18
19 /** 19 /**
20 * Return the baked view of all entries 20 * Return the baked view of all entries
21 - *  
22 - * @return  
23 */ 21 */
24 public T all(); 22 public T all();
25 23
java/common/com/mumfrey/liteloader/interfaces/Injectable.java
@@ -28,13 +28,13 @@ public interface Injectable @@ -28,13 +28,13 @@ public interface Injectable
28 /** 28 /**
29 * @param classLoader 29 * @param classLoader
30 * @param injectIntoParent 30 * @param injectIntoParent
31 - * @return 31 + * @return whether the injection was successful or not
32 * @throws MalformedURLException 32 * @throws MalformedURLException
33 */ 33 */
34 public abstract boolean injectIntoClassPath(LaunchClassLoader classLoader, boolean injectIntoParent) throws MalformedURLException; 34 public abstract boolean injectIntoClassPath(LaunchClassLoader classLoader, boolean injectIntoParent) throws MalformedURLException;
35 35
36 /** 36 /**
37 - * @return 37 + * Get the injection strategy for this object
38 */ 38 */
39 public abstract InjectionStrategy getInjectionStrategy(); 39 public abstract InjectionStrategy getInjectionStrategy();
40 } 40 }
java/common/com/mumfrey/liteloader/interfaces/Loadable.java
@@ -67,7 +67,6 @@ public interface Loadable&lt;L&gt; extends Comparable&lt;L&gt; @@ -67,7 +67,6 @@ public interface Loadable&lt;L&gt; extends Comparable&lt;L&gt;
67 * Get whether this loadable is currently enabled in the context of the supplied mods list 67 * Get whether this loadable is currently enabled in the context of the supplied mods list
68 * 68 *
69 * @param environment 69 * @param environment
70 - * @return  
71 */ 70 */
72 public abstract boolean isEnabled(LoaderEnvironment environment); 71 public abstract boolean isEnabled(LoaderEnvironment environment);
73 72
java/common/com/mumfrey/liteloader/interfaces/LoadableMod.java
@@ -86,7 +86,6 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable @@ -86,7 +86,6 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
86 * 86 *
87 * @param metaKey metadata key 87 * @param metaKey metadata key
88 * @param defaultValue metadata value 88 * @param defaultValue metadata value
89 - * @return  
90 */ 89 */
91 public abstract String getMetaValue(String metaKey, String defaultValue); 90 public abstract String getMetaValue(String metaKey, String defaultValue);
92 91
java/common/com/mumfrey/liteloader/interfaces/LoaderEnumerator.java
@@ -36,7 +36,6 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -36,7 +36,6 @@ public interface LoaderEnumerator extends ModularEnumerator
36 * Check API requirements for the supplied container 36 * Check API requirements for the supplied container
37 * 37 *
38 * @param container 38 * @param container
39 - * @return  
40 */ 39 */
41 public abstract boolean checkAPIRequirements(LoadableMod<?> container); 40 public abstract boolean checkAPIRequirements(LoadableMod<?> container);
42 41
@@ -44,7 +43,6 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -44,7 +43,6 @@ public interface LoaderEnumerator extends ModularEnumerator
44 * Check intra-mod dependencies for the supplied container 43 * Check intra-mod dependencies for the supplied container
45 * 44 *
46 * @param base 45 * @param base
47 - * @return  
48 */ 46 */
49 public abstract boolean checkDependencies(LoadableMod<?> base); 47 public abstract boolean checkDependencies(LoadableMod<?> base);
50 48
@@ -52,7 +50,6 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -52,7 +50,6 @@ public interface LoaderEnumerator extends ModularEnumerator
52 * Inflect mod identifier from the supplied mod class 50 * Inflect mod identifier from the supplied mod class
53 * 51 *
54 * @param modClass 52 * @param modClass
55 - * @return  
56 */ 53 */
57 public abstract String getIdentifier(Class<? extends LiteMod> modClass); 54 public abstract String getIdentifier(Class<? extends LiteMod> modClass);
58 55
@@ -60,7 +57,6 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -60,7 +57,6 @@ public interface LoaderEnumerator extends ModularEnumerator
60 * Get the container which the specified mod is loaded from 57 * Get the container which the specified mod is loaded from
61 * 58 *
62 * @param modClass 59 * @param modClass
63 - * @return  
64 */ 60 */
65 public abstract LoadableMod<?> getContainer(Class<? extends LiteMod> modClass); 61 public abstract LoadableMod<?> getContainer(Class<? extends LiteMod> modClass);
66 62
@@ -68,14 +64,11 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -68,14 +64,11 @@ public interface LoaderEnumerator extends ModularEnumerator
68 * Get the container for the specified mod identifier 64 * Get the container for the specified mod identifier
69 * 65 *
70 * @param identifier 66 * @param identifier
71 - * @return  
72 */ 67 */
73 public abstract LoadableMod<?> getContainer(String identifier); 68 public abstract LoadableMod<?> getContainer(String identifier);
74 69
75 /** 70 /**
76 * Get all containers identified at discover-time as disabled 71 * Get all containers identified at discover-time as disabled
77 - *  
78 - * @return  
79 */ 72 */
80 public abstract Collection<? extends ModInfo<Loadable<?>>> getDisabledContainers(); 73 public abstract Collection<? extends ModInfo<Loadable<?>>> getDisabledContainers();
81 74
@@ -83,27 +76,26 @@ public interface LoaderEnumerator extends ModularEnumerator @@ -83,27 +76,26 @@ public interface LoaderEnumerator extends ModularEnumerator
83 * @param modClass 76 * @param modClass
84 * @param metaDataKey 77 * @param metaDataKey
85 * @param defaultValue 78 * @param defaultValue
86 - * @return  
87 */ 79 */
88 public abstract String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue); 80 public abstract String getModMetaData(Class<? extends LiteMod> modClass, String metaDataKey, String defaultValue);
89 81
90 /** 82 /**
91 - * @return 83 + * Get the total number of mods to load
92 */ 84 */
93 public abstract int modsToLoadCount(); 85 public abstract int modsToLoadCount();
94 86
95 /** 87 /**
96 - * @return 88 + * Get all mods to load
97 */ 89 */
98 public abstract Collection<? extends ModInfo<LoadableMod<?>>> getModsToLoad(); 90 public abstract Collection<? extends ModInfo<LoadableMod<?>>> getModsToLoad();
99 91
100 /** 92 /**
101 - * @return 93 + * Get all tweakers which were injected
102 */ 94 */
103 public abstract List<? extends ModInfo<Loadable<?>>> getInjectedTweaks(); 95 public abstract List<? extends ModInfo<Loadable<?>>> getInjectedTweaks();
104 96
105 /** 97 /**
106 - * @return 98 + * Get the shared modlist data
107 */ 99 */
108 public abstract Map<String, Map<String, String>> getSharedModList(); 100 public abstract Map<String, Map<String, String>> getSharedModList();
109 } 101 }
java/common/com/mumfrey/liteloader/interfaces/ModularEnumerator.java
@@ -21,13 +21,11 @@ public interface ModularEnumerator @@ -21,13 +21,11 @@ public interface ModularEnumerator
21 21
22 /** 22 /**
23 * @param container 23 * @param container
24 - * @return  
25 */ 24 */
26 public abstract boolean registerModContainer(LoadableMod<?> container); 25 public abstract boolean registerModContainer(LoadableMod<?> container);
27 26
28 /** 27 /**
29 * @param container 28 * @param container
30 - * @return  
31 */ 29 */
32 public abstract boolean registerTweakContainer(TweakContainer<File> container); 30 public abstract boolean registerTweakContainer(TweakContainer<File> container);
33 31
java/common/com/mumfrey/liteloader/interfaces/PanelManager.java
@@ -26,57 +26,59 @@ public interface PanelManager&lt;TParentScreen&gt; extends TickObserver, PostRenderObs @@ -26,57 +26,59 @@ public interface PanelManager&lt;TParentScreen&gt; extends TickObserver, PostRenderObs
26 public abstract void onStartupComplete(); 26 public abstract void onStartupComplete();
27 27
28 /** 28 /**
29 - * 29 + * Hide the LiteLoader tab
30 */ 30 */
31 public abstract void hideTab(); 31 public abstract void hideTab();
32 32
33 /** 33 /**
34 - * @param show 34 + * Set the LiteLoader tab's visibility
35 */ 35 */
36 public abstract void setTabVisible(boolean show); 36 public abstract void setTabVisible(boolean show);
37 37
38 /** 38 /**
39 - * @return 39 + * Get whether the LiteLoader tab is visible
40 */ 40 */
41 public abstract boolean isTabVisible(); 41 public abstract boolean isTabVisible();
42 42
43 /** 43 /**
44 - * @param show 44 + * Set whether the LiteLoader tab should remain expanded
45 */ 45 */
46 public abstract void setTabAlwaysExpanded(boolean expand); 46 public abstract void setTabAlwaysExpanded(boolean expand);
47 47
48 /** 48 /**
49 - * @return 49 + * Get whether the LiteLoader tab should remain expanded
50 */ 50 */
51 public abstract boolean isTabAlwaysExpanded(); 51 public abstract boolean isTabAlwaysExpanded();
52 52
53 /** 53 /**
54 - * @param parentScreen 54 + * Display the LiteLoader panel
  55 + *
  56 + * @param parentScreen Parent screen to display the panel on top of
55 */ 57 */
56 public abstract void displayLiteLoaderPanel(TParentScreen parentScreen); 58 public abstract void displayLiteLoaderPanel(TParentScreen parentScreen);
57 59
58 /** 60 /**
59 - * @return 61 + * Get the number of startup errors
60 */ 62 */
61 public abstract int getStartupErrorCount(); 63 public abstract int getStartupErrorCount();
62 64
63 /** 65 /**
64 - * @return 66 + * Get the number of critical startup errors
65 */ 67 */
66 public abstract int getCriticalErrorCount(); 68 public abstract int getCriticalErrorCount();
67 69
68 /** 70 /**
69 - * @param notification 71 + * Set the current notification text
70 */ 72 */
71 public abstract void setNotification(String notification); 73 public abstract void setNotification(String notification);
72 74
73 /** 75 /**
74 - * @param forceUpdate 76 + * Set whether "force update" is enabled
75 */ 77 */
76 public abstract void setForceUpdateEnabled(boolean forceUpdate); 78 public abstract void setForceUpdateEnabled(boolean forceUpdate);
77 79
78 /** 80 /**
79 - * @return 81 + * Get whether "force update" is enabled
80 */ 82 */
81 public abstract boolean isForceUpdateEnabled(); 83 public abstract boolean isForceUpdateEnabled();
82 } 84 }
java/common/com/mumfrey/liteloader/launch/ClassPathUtilities.java
@@ -229,7 +229,6 @@ public abstract class ClassPathUtilities @@ -229,7 +229,6 @@ public abstract class ClassPathUtilities
229 * Is the specified jar on the game launch classpath 229 * Is the specified jar on the game launch classpath
230 * 230 *
231 * @param jarFile 231 * @param jarFile
232 - * @return  
233 */ 232 */
234 public static boolean isJarOnClassPath(File jarFile) 233 public static boolean isJarOnClassPath(File jarFile)
235 { 234 {
@@ -257,7 +256,6 @@ public abstract class ClassPathUtilities @@ -257,7 +256,6 @@ public abstract class ClassPathUtilities
257 * 256 *
258 * @param contextClass 257 * @param contextClass
259 * @param resource 258 * @param resource
260 - * @return  
261 */ 259 */
262 public static File getPathToResource(Class<?> contextClass, String resource) 260 public static File getPathToResource(Class<?> contextClass, String resource)
263 { 261 {
@@ -288,7 +286,6 @@ public abstract class ClassPathUtilities @@ -288,7 +286,6 @@ public abstract class ClassPathUtilities
288 /** 286 /**
289 * @param contextClass 287 * @param contextClass
290 * @param resource 288 * @param resource
291 - * @return  
292 */ 289 */
293 public static boolean deleteClassPathJarContaining(Class<?> contextClass, String resource) 290 public static boolean deleteClassPathJarContaining(Class<?> contextClass, String resource)
294 { 291 {
@@ -303,7 +300,6 @@ public abstract class ClassPathUtilities @@ -303,7 +300,6 @@ public abstract class ClassPathUtilities
303 300
304 /** 301 /**
305 * @param jarFileName 302 * @param jarFileName
306 - * @return  
307 */ 303 */
308 public static boolean deleteClassPathJar(String jarFileName) 304 public static boolean deleteClassPathJar(String jarFileName)
309 { 305 {
java/common/com/mumfrey/liteloader/launch/ClassTransformerManager.java
@@ -94,7 +94,6 @@ public class ClassTransformerManager @@ -94,7 +94,6 @@ public class ClassTransformerManager
94 94
95 /** 95 /**
96 * @param transformerClass 96 * @param transformerClass
97 - * @return  
98 */ 97 */
99 public boolean injectTransformer(String transformerClass) 98 public boolean injectTransformer(String transformerClass)
100 { 99 {
@@ -109,7 +108,6 @@ public class ClassTransformerManager @@ -109,7 +108,6 @@ public class ClassTransformerManager
109 108
110 /** 109 /**
111 * @param transformerClasses 110 * @param transformerClasses
112 - * @return  
113 */ 111 */
114 public boolean injectTransformers(Collection<String> transformerClasses) 112 public boolean injectTransformers(Collection<String> transformerClasses)
115 { 113 {
@@ -124,7 +122,6 @@ public class ClassTransformerManager @@ -124,7 +122,6 @@ public class ClassTransformerManager
124 122
125 /** 123 /**
126 * @param transformerClasses 124 * @param transformerClasses
127 - * @return  
128 */ 125 */
129 public boolean injectTransformers(String[] transformerClasses) 126 public boolean injectTransformers(String[] transformerClasses)
130 { 127 {
java/common/com/mumfrey/liteloader/launch/InjectionStrategy.java
@@ -38,7 +38,6 @@ public class InjectionStrategy @@ -38,7 +38,6 @@ public class InjectionStrategy
38 * Parse an InjectionPosition from the specified "injectAt" string 38 * Parse an InjectionPosition from the specified "injectAt" string
39 * 39 *
40 * @param injectAt 40 * @param injectAt
41 - * @return  
42 */ 41 */
43 public static InjectionPosition parsePosition(String injectAt) 42 public static InjectionPosition parsePosition(String injectAt)
44 { 43 {
@@ -52,7 +51,6 @@ public class InjectionStrategy @@ -52,7 +51,6 @@ public class InjectionStrategy
52 * Parse InjectionPosition params from the specified "injectAt" string 51 * Parse InjectionPosition params from the specified "injectAt" string
53 * 52 *
54 * @param injectAt 53 * @param injectAt
55 - * @return  
56 */ 54 */
57 public String[] parseParams(String injectAt) 55 public String[] parseParams(String injectAt)
58 { 56 {
@@ -124,7 +122,6 @@ public class InjectionStrategy @@ -124,7 +122,6 @@ public class InjectionStrategy
124 * Parse an injection strategy from the specified injectAt string 122 * Parse an injection strategy from the specified injectAt string
125 * 123 *
126 * @param injectAt 124 * @param injectAt
127 - * @return  
128 */ 125 */
129 public static InjectionStrategy parseStrategy(String injectAt) 126 public static InjectionStrategy parseStrategy(String injectAt)
130 { 127 {
@@ -135,7 +132,6 @@ public class InjectionStrategy @@ -135,7 +132,6 @@ public class InjectionStrategy
135 * Parse an injection strategy from the specified injectAt string 132 * Parse an injection strategy from the specified injectAt string
136 * 133 *
137 * @param injectAt 134 * @param injectAt
138 - * @return  
139 */ 135 */
140 public static InjectionStrategy parseStrategy(String injectAt, InjectionStrategy defaultStrategy) 136 public static InjectionStrategy parseStrategy(String injectAt, InjectionStrategy defaultStrategy)
141 { 137 {
java/common/com/mumfrey/liteloader/launch/LiteLoaderTweaker.java
@@ -62,7 +62,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -62,7 +62,7 @@ public class LiteLoaderTweaker implements ITweaker
62 private boolean completed; 62 private boolean completed;
63 63
64 /** 64 /**
65 - * @return 65 + * Get whether this state is completed
66 */ 66 */
67 public boolean isCompleted() 67 public boolean isCompleted()
68 { 68 {
@@ -70,7 +70,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -70,7 +70,7 @@ public class LiteLoaderTweaker implements ITweaker
70 } 70 }
71 71
72 /** 72 /**
73 - * @return 73 + * Get whether the tweaker is currrently in this state
74 */ 74 */
75 public boolean isInState() 75 public boolean isInState()
76 { 76 {
@@ -131,7 +131,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -131,7 +131,7 @@ public class LiteLoaderTweaker implements ITweaker
131 } 131 }
132 132
133 /** 133 /**
134 - * @return 134 + * Get the state which follows this state
135 */ 135 */
136 private StartupState getNextState() 136 private StartupState getNextState()
137 { 137 {
@@ -140,7 +140,6 @@ public class LiteLoaderTweaker implements ITweaker @@ -140,7 +140,6 @@ public class LiteLoaderTweaker implements ITweaker
140 140
141 /** 141 /**
142 * @param next 142 * @param next
143 - * @return  
144 */ 143 */
145 public boolean canGotoState(StartupState next) 144 public boolean canGotoState(StartupState next)
146 { 145 {
@@ -153,7 +152,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -153,7 +152,7 @@ public class LiteLoaderTweaker implements ITweaker
153 } 152 }
154 153
155 /** 154 /**
156 - * @return 155 + * Get the current state
157 */ 156 */
158 public static StartupState getCurrent() 157 public static StartupState getCurrent()
159 { 158 {
@@ -449,7 +448,6 @@ public class LiteLoaderTweaker implements ITweaker @@ -449,7 +448,6 @@ public class LiteLoaderTweaker implements ITweaker
449 /** 448 /**
450 * @param tweakClass 449 * @param tweakClass
451 * @param priority 450 * @param priority
452 - * @return  
453 */ 451 */
454 public boolean addCascadedTweaker(String tweakClass, int priority) 452 public boolean addCascadedTweaker(String tweakClass, int priority)
455 { 453 {
@@ -474,7 +472,6 @@ public class LiteLoaderTweaker implements ITweaker @@ -474,7 +472,6 @@ public class LiteLoaderTweaker implements ITweaker
474 * 472 *
475 * @param bootstrapClassName 473 * @param bootstrapClassName
476 * @param classLoader 474 * @param classLoader
477 - * @return  
478 */ 475 */
479 protected LoaderBootstrap spawnBootstrap(String bootstrapClassName, ClassLoader classLoader) 476 protected LoaderBootstrap spawnBootstrap(String bootstrapClassName, ClassLoader classLoader)
480 { 477 {
@@ -503,7 +500,6 @@ public class LiteLoaderTweaker implements ITweaker @@ -503,7 +500,6 @@ public class LiteLoaderTweaker implements ITweaker
503 * @param gameDirectory 500 * @param gameDirectory
504 * @param assetsDirectory 501 * @param assetsDirectory
505 * @param profile 502 * @param profile
506 - * @return  
507 */ 503 */
508 protected StartupEnvironment spawnStartupEnvironment(List<String> args, File gameDirectory, File assetsDirectory, String profile) 504 protected StartupEnvironment spawnStartupEnvironment(List<String> args, File gameDirectory, File assetsDirectory, String profile)
509 { 505 {
@@ -524,7 +520,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -524,7 +520,7 @@ public class LiteLoaderTweaker implements ITweaker
524 } 520 }
525 521
526 /** 522 /**
527 - * @return 523 + * Get the game jar url (probably)
528 */ 524 */
529 public static URL getJarUrl() 525 public static URL getJarUrl()
530 { 526 {
@@ -586,7 +582,7 @@ public class LiteLoaderTweaker implements ITweaker @@ -586,7 +582,7 @@ public class LiteLoaderTweaker implements ITweaker
586 } 582 }
587 583
588 /** 584 /**
589 - * @return 585 + * Get whether to enable the loading bar for minecraft startup
590 */ 586 */
591 public static boolean loadingBarEnabled() 587 public static boolean loadingBarEnabled()
592 { 588 {
java/common/com/mumfrey/liteloader/launch/LoaderEnvironment.java
@@ -72,7 +72,6 @@ public interface LoaderEnvironment extends GameEnvironment @@ -72,7 +72,6 @@ public interface LoaderEnvironment extends GameEnvironment
72 * Inflect a versioned configuration path for a specific version 72 * Inflect a versioned configuration path for a specific version
73 * 73 *
74 * @param version 74 * @param version
75 - * @return  
76 */ 75 */
77 public abstract File inflectVersionedConfigPath(LiteLoaderVersion version); 76 public abstract File inflectVersionedConfigPath(LiteLoaderVersion version);
78 77
java/common/com/mumfrey/liteloader/launch/LoaderProperties.java
@@ -29,7 +29,6 @@ public interface LoaderProperties @@ -29,7 +29,6 @@ public interface LoaderProperties
29 * Get a boolean property from the properties file 29 * Get a boolean property from the properties file
30 * 30 *
31 * @param propertyName 31 * @param propertyName
32 - * @return  
33 */ 32 */
34 public abstract boolean getBooleanProperty(String propertyName); 33 public abstract boolean getBooleanProperty(String propertyName);
35 34
@@ -38,7 +37,6 @@ public interface LoaderProperties @@ -38,7 +37,6 @@ public interface LoaderProperties
38 * 37 *
39 * @param propertyName 38 * @param propertyName
40 * @param defaultValue 39 * @param defaultValue
41 - * @return  
42 */ 40 */
43 public abstract boolean getAndStoreBooleanProperty(String propertyName, boolean defaultValue); 41 public abstract boolean getAndStoreBooleanProperty(String propertyName, boolean defaultValue);
44 42
@@ -54,7 +52,6 @@ public interface LoaderProperties @@ -54,7 +52,6 @@ public interface LoaderProperties
54 * Get an integer property from the properties file 52 * Get an integer property from the properties file
55 * 53 *
56 * @param propertyName 54 * @param propertyName
57 - * @return  
58 */ 55 */
59 public abstract int getIntegerProperty(String propertyName); 56 public abstract int getIntegerProperty(String propertyName);
60 57
@@ -63,7 +60,6 @@ public interface LoaderProperties @@ -63,7 +60,6 @@ public interface LoaderProperties
63 * 60 *
64 * @param propertyName 61 * @param propertyName
65 * @param defaultValue 62 * @param defaultValue
66 - * @return  
67 */ 63 */
68 public abstract int getAndStoreIntegerProperty(String propertyName, int defaultValue); 64 public abstract int getAndStoreIntegerProperty(String propertyName, int defaultValue);
69 65
@@ -71,7 +67,6 @@ public interface LoaderProperties @@ -71,7 +67,6 @@ public interface LoaderProperties
71 * Get a stored mod revision number from the properties file 67 * Get a stored mod revision number from the properties file
72 * 68 *
73 * @param modKey 69 * @param modKey
74 - * @return  
75 */ 70 */
76 public abstract int getLastKnownModRevision(String modKey); 71 public abstract int getLastKnownModRevision(String modKey);
77 72
java/common/com/mumfrey/liteloader/launch/StartupEnvironment.java
@@ -48,8 +48,6 @@ public abstract class StartupEnvironment implements GameEnvironment @@ -48,8 +48,6 @@ public abstract class StartupEnvironment implements GameEnvironment
48 48
49 /** 49 /**
50 * @param args 50 * @param args
51 - * @param gameDirectory  
52 - * @param assetsDirectory  
53 */ 51 */
54 @SuppressWarnings("unchecked") 52 @SuppressWarnings("unchecked")
55 public void initArgs(List<String> args) 53 public void initArgs(List<String> args)
@@ -128,10 +126,6 @@ public abstract class StartupEnvironment implements GameEnvironment @@ -128,10 +126,6 @@ public abstract class StartupEnvironment implements GameEnvironment
128 this.launchArgs.put(classifiedArg, arg); 126 this.launchArgs.put(classifiedArg, arg);
129 } 127 }
130 128
131 - /**  
132 - * @param gameDirectory  
133 - * @param assetsDirectory  
134 - */  
135 public void provideRequiredArgs() 129 public void provideRequiredArgs()
136 { 130 {
137 if (this.launchArgs.get("--version") == null) 131 if (this.launchArgs.get("--version") == null)
@@ -164,7 +158,7 @@ public abstract class StartupEnvironment implements GameEnvironment @@ -164,7 +158,7 @@ public abstract class StartupEnvironment implements GameEnvironment
164 } 158 }
165 159
166 /** 160 /**
167 - * @return 161 + * Get the mod filter list
168 */ 162 */
169 public List<String> getModFilterList() 163 public List<String> getModFilterList()
170 { 164 {
@@ -172,7 +166,7 @@ public abstract class StartupEnvironment implements GameEnvironment @@ -172,7 +166,7 @@ public abstract class StartupEnvironment implements GameEnvironment
172 } 166 }
173 167
174 /** 168 /**
175 - * @return 169 + * Get API classes to load
176 */ 170 */
177 public List<String> getAPIsToLoad() 171 public List<String> getAPIsToLoad()
178 { 172 {
java/common/com/mumfrey/liteloader/messaging/Message.java
@@ -96,7 +96,6 @@ public class Message @@ -96,7 +96,6 @@ public class Message
96 * Check if this message is on the specified channel 96 * Check if this message is on the specified channel
97 * 97 *
98 * @param channel Full name of the channel to check against (case sensitive) 98 * @param channel Full name of the channel to check against (case sensitive)
99 - * @return  
100 */ 99 */
101 public boolean isChannel(String channel) 100 public boolean isChannel(String channel)
102 { 101 {
@@ -107,7 +106,6 @@ public class Message @@ -107,7 +106,6 @@ public class Message
107 * Check if this message has the specified category 106 * Check if this message has the specified category
108 * 107 *
109 * @param category 108 * @param category
110 - * @return  
111 */ 109 */
112 public boolean isCategory(String category) 110 public boolean isCategory(String category)
113 { 111 {
@@ -118,7 +116,6 @@ public class Message @@ -118,7 +116,6 @@ public class Message
118 * Get (and implicit cast) a value from this message's payload 116 * Get (and implicit cast) a value from this message's payload
119 * 117 *
120 * @param key 118 * @param key
121 - * @return  
122 */ 119 */
123 @SuppressWarnings("unchecked") 120 @SuppressWarnings("unchecked")
124 public <T> T get(String key) 121 public <T> T get(String key)
@@ -167,7 +164,6 @@ public class Message @@ -167,7 +164,6 @@ public class Message
167 * Build a KV map from interleaved keys and values, convenience function 164 * Build a KV map from interleaved keys and values, convenience function
168 * 165 *
169 * @param args 166 * @param args
170 - * @return  
171 */ 167 */
172 public static Map<String, ?> buildMap(Object... args) 168 public static Map<String, ?> buildMap(Object... args)
173 { 169 {
java/common/com/mumfrey/liteloader/modconfig/AdvancedExposable.java
@@ -29,7 +29,7 @@ public interface AdvancedExposable extends Exposable @@ -29,7 +29,7 @@ public interface AdvancedExposable extends Exposable
29 * @param configFile Default config file, generated by the ExposableOptions for this Exposable 29 * @param configFile Default config file, generated by the ExposableOptions for this Exposable
30 * @param configFileLocation Default config file location, from the config strategy 30 * @param configFileLocation Default config file location, from the config strategy
31 * @param defaultFileName Default config file name, from the ExposableOptions 31 * @param defaultFileName Default config file name, from the ExposableOptions
32 - * @return 32 + * @return config file location to return, return null to use the default
33 */ 33 */
34 public abstract File getConfigFile(File configFile, File configFileLocation, String defaultFileName); 34 public abstract File getConfigFile(File configFile, File configFileLocation, String defaultFileName);
35 } 35 }
java/common/com/mumfrey/liteloader/modconfig/ConfigManager.java
@@ -133,7 +133,6 @@ public class ConfigManager @@ -133,7 +133,6 @@ public class ConfigManager
133 * Check whether a config panel is available for the specified class 133 * Check whether a config panel is available for the specified class
134 * 134 *
135 * @param modClass 135 * @param modClass
136 - * @return  
137 */ 136 */
138 public boolean hasPanel(Class<? extends LiteMod> modClass) 137 public boolean hasPanel(Class<? extends LiteMod> modClass)
139 { 138 {
@@ -144,7 +143,6 @@ public class ConfigManager @@ -144,7 +143,6 @@ public class ConfigManager
144 * Instance a new config panel for the specified mod class if one is available 143 * Instance a new config panel for the specified mod class if one is available
145 * 144 *
146 * @param modClass 145 * @param modClass
147 - * @return  
148 */ 146 */
149 public ConfigPanel getPanel(Class<? extends LiteMod> modClass) 147 public ConfigPanel getPanel(Class<? extends LiteMod> modClass)
150 { 148 {
@@ -215,7 +213,6 @@ public class ConfigManager @@ -215,7 +213,6 @@ public class ConfigManager
215 213
216 /** 214 /**
217 * @param exposable 215 * @param exposable
218 - * @return  
219 */ 216 */
220 public static ConfigStrategy getConfigStrategy(Exposable exposable) 217 public static ConfigStrategy getConfigStrategy(Exposable exposable)
221 { 218 {
java/common/com/mumfrey/liteloader/permissions/Permission.java
@@ -72,8 +72,6 @@ public class Permission @@ -72,8 +72,6 @@ public class Permission
72 72
73 /** 73 /**
74 * Get whether this node is a root node (read only) 74 * Get whether this node is a root node (read only)
75 - *  
76 - * @return  
77 */ 75 */
78 public boolean isRoot() 76 public boolean isRoot()
79 { 77 {
@@ -82,8 +80,6 @@ public class Permission @@ -82,8 +80,6 @@ public class Permission
82 80
83 /** 81 /**
84 * Get whether this node is a wildcard node 82 * Get whether this node is a wildcard node
85 - *  
86 - * @return  
87 */ 83 */
88 public boolean isWildcard() 84 public boolean isWildcard()
89 { 85 {
@@ -92,8 +88,6 @@ public class Permission @@ -92,8 +88,6 @@ public class Permission
92 88
93 /** 89 /**
94 * Get the name of this permission node 90 * Get the name of this permission node
95 - *  
96 - * @return  
97 */ 91 */
98 public String getName() 92 public String getName()
99 { 93 {
@@ -102,8 +96,6 @@ public class Permission @@ -102,8 +96,6 @@ public class Permission
102 96
103 /** 97 /**
104 * Get the value of this permission node 98 * Get the value of this permission node
105 - *  
106 - * @return  
107 */ 99 */
108 public boolean getValue() 100 public boolean getValue()
109 { 101 {
@@ -124,7 +116,6 @@ public class Permission @@ -124,7 +116,6 @@ public class Permission
124 * Get the specified node name 116 * Get the specified node name
125 * 117 *
126 * @param name 118 * @param name
127 - * @return  
128 */ 119 */
129 public Permission getPermission(String name) 120 public Permission getPermission(String name)
130 { 121 {
@@ -162,7 +153,6 @@ public class Permission @@ -162,7 +153,6 @@ public class Permission
162 * Set the specified node name 153 * Set the specified node name
163 * 154 *
164 * @param name 155 * @param name
165 - * @return  
166 */ 156 */
167 public Permission setPermission(String name) 157 public Permission setPermission(String name)
168 { 158 {
@@ -174,7 +164,6 @@ public class Permission @@ -174,7 +164,6 @@ public class Permission
174 * 164 *
175 * @param name 165 * @param name
176 * @param value 166 * @param value
177 - * @return  
178 */ 167 */
179 public Permission setPermission(String name, boolean value) 168 public Permission setPermission(String name, boolean value)
180 { 169 {
@@ -207,7 +196,6 @@ public class Permission @@ -207,7 +196,6 @@ public class Permission
207 * 196 *
208 * @param name 197 * @param name
209 * @param value 198 * @param value
210 - * @return  
211 */ 199 */
212 public Permission setPermissionAndValue(String name, boolean value) 200 public Permission setPermissionAndValue(String name, boolean value)
213 { 201 {
@@ -221,7 +209,6 @@ public class Permission @@ -221,7 +209,6 @@ public class Permission
221 * 209 *
222 * @param name 210 * @param name
223 * @param value 211 * @param value
224 - * @return  
225 */ 212 */
226 public boolean isSet(String name, boolean value) 213 public boolean isSet(String name, boolean value)
227 { 214 {
java/common/com/mumfrey/liteloader/permissions/Permissions.java
@@ -19,7 +19,6 @@ public interface Permissions @@ -19,7 +19,6 @@ public interface Permissions
19 * Returns true if the authority says we have this permission or false if the permission is denied or not set 19 * Returns true if the authority says we have this permission or false if the permission is denied or not set
20 * 20 *
21 * @param permission Name of the permission to test for 21 * @param permission Name of the permission to test for
22 - * @return  
23 */ 22 */
24 public abstract boolean getHasPermission(String permission); 23 public abstract boolean getHasPermission(String permission);
25 24
java/common/com/mumfrey/liteloader/permissions/PermissionsManager.java
@@ -13,8 +13,7 @@ public interface PermissionsManager @@ -13,8 +13,7 @@ public interface PermissionsManager
13 /** 13 /**
14 * Get the underlying permissions node for this manager for the specified mod 14 * Get the underlying permissions node for this manager for the specified mod
15 * 15 *
16 - * @param modName Mod to fetch permissions for  
17 - * @return 16 + * @param mod Mod to fetch permissions for
18 */ 17 */
19 public abstract Permissions getPermissions(Permissible mod); 18 public abstract Permissions getPermissions(Permissible mod);
20 19
java/common/com/mumfrey/liteloader/permissions/PermissionsManagerClient.java
@@ -86,8 +86,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -86,8 +86,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
86 86
87 /** 87 /**
88 * Get a reference to the singleton instance of the client permissions manager 88 * Get a reference to the singleton instance of the client permissions manager
89 - *  
90 - * @return  
91 */ 89 */
92 public static PermissionsManagerClient getInstance() 90 public static PermissionsManagerClient getInstance()
93 { 91 {
@@ -205,8 +203,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -205,8 +203,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
205 203
206 /** 204 /**
207 * Send permission query packets to the server for all registered mods 205 * Send permission query packets to the server for all registered mods
208 - *  
209 - * @param minecraft Minecraft instance  
210 */ 206 */
211 protected void sendPermissionQueries() 207 protected void sendPermissionQueries()
212 { 208 {
@@ -219,7 +215,7 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -219,7 +215,7 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
219 * issued automatically by the client permissions manager when connecting to a new server. However you can call use this 215 * issued automatically by the client permissions manager when connecting to a new server. However you can call use this
220 * method to "force" a refresh of permissions when needed. 216 * method to "force" a refresh of permissions when needed.
221 * 217 *
222 - * @param modName name of the mod to send a query packet for 218 + * @param mod mod to send a query packet for
223 */ 219 */
224 public void sendPermissionQuery(Permissible mod) 220 public void sendPermissionQuery(Permissible mod)
225 { 221 {
@@ -378,7 +374,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -378,7 +374,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
378 * Get the value of the specified permission for all mods. 374 * Get the value of the specified permission for all mods.
379 * 375 *
380 * @param permission Permission to check for 376 * @param permission Permission to check for
381 - * @return  
382 */ 377 */
383 public boolean getPermission(String permission) 378 public boolean getPermission(String permission)
384 { 379 {
@@ -390,7 +385,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -390,7 +385,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
390 * 385 *
391 * @param permission Permission to check for 386 * @param permission Permission to check for
392 * @param defaultValue Value to return if the permission is not set 387 * @param defaultValue Value to return if the permission is not set
393 - * @return  
394 */ 388 */
395 public boolean getPermission(String permission, boolean defaultValue) 389 public boolean getPermission(String permission, boolean defaultValue)
396 { 390 {
@@ -403,7 +397,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -403,7 +397,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
403 * 397 *
404 * @param mod 398 * @param mod
405 * @param permission 399 * @param permission
406 - * @return  
407 */ 400 */
408 public boolean getModPermission(Permissible mod, String permission) 401 public boolean getModPermission(Permissible mod, String permission)
409 { 402 {
@@ -425,7 +418,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -425,7 +418,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
425 * 418 *
426 * @param modName 419 * @param modName
427 * @param permission 420 * @param permission
428 - * @return  
429 */ 421 */
430 public boolean getModPermission(String modName, String permission) 422 public boolean getModPermission(String modName, String permission)
431 { 423 {
@@ -441,7 +433,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -441,7 +433,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
441 * @param mod 433 * @param mod
442 * @param permission 434 * @param permission
443 * @param defaultValue 435 * @param defaultValue
444 - * @return  
445 */ 436 */
446 public boolean getModPermission(Permissible mod, String permission, boolean defaultValue) 437 public boolean getModPermission(Permissible mod, String permission, boolean defaultValue)
447 { 438 {
@@ -463,7 +454,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -463,7 +454,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
463 * 454 *
464 * @param modName 455 * @param modName
465 * @param permission 456 * @param permission
466 - * @return  
467 */ 457 */
468 public boolean getModPermission(String modName, String permission, boolean defaultValue) 458 public boolean getModPermission(String modName, String permission, boolean defaultValue)
469 { 459 {
@@ -474,7 +464,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann @@ -474,7 +464,6 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
474 /** 464 /**
475 * @param modName 465 * @param modName
476 * @param permission 466 * @param permission
477 - * @return  
478 */ 467 */
479 protected static String formatModPermission(String modName, String permission) 468 protected static String formatModPermission(String modName, String permission)
480 { 469 {
java/common/com/mumfrey/liteloader/permissions/ReplicatedPermissions.java
@@ -9,15 +9,11 @@ public interface ReplicatedPermissions extends Permissions @@ -9,15 +9,11 @@ public interface ReplicatedPermissions extends Permissions
9 { 9 {
10 /** 10 /**
11 * Get the time that this object was received from the remote authority 11 * Get the time that this object was received from the remote authority
12 - *  
13 - * @return  
14 */ 12 */
15 public abstract long getReplicationTime(); 13 public abstract long getReplicationTime();
16 14
17 /** 15 /**
18 - * True if this permissions object is valid (within cache period)  
19 - *  
20 - * @return 16 + * Return true if this permissions object is valid (within cache period)
21 */ 17 */
22 public abstract boolean isValid(); 18 public abstract boolean isValid();
23 19
java/common/com/mumfrey/liteloader/permissions/ServerPermissions.java
@@ -79,7 +79,7 @@ public class ServerPermissions implements ReplicatedPermissions @@ -79,7 +79,7 @@ public class ServerPermissions implements ReplicatedPermissions
79 } 79 }
80 80
81 /** 81 /**
82 - * @return 82 + * Get the permissible mod name
83 */ 83 */
84 public String getModName() 84 public String getModName()
85 { 85 {
java/common/com/mumfrey/liteloader/transformers/ByteCodeUtilities.java
@@ -90,8 +90,8 @@ public abstract class ByteCodeUtilities @@ -90,8 +90,8 @@ public abstract class ByteCodeUtilities
90 * Get the first variable index in the supplied method which is not an argument or "this" reference, this corresponds 90 * Get the first variable index in the supplied method which is not an argument or "this" reference, this corresponds
91 * to the size of the arguments passed in to the method plus an extra spot for "this" if the method is non-static 91 * to the size of the arguments passed in to the method plus an extra spot for "this" if the method is non-static
92 * 92 *
93 - * @param method  
94 - * @return 93 + * @param method MethodNode to inspect
  94 + * @return first available local index which is NOT used by a method argument or "this"
95 */ 95 */
96 public static int getFirstNonArgLocalIndex(MethodNode method) 96 public static int getFirstNonArgLocalIndex(MethodNode method)
97 { 97 {
@@ -102,9 +102,9 @@ public abstract class ByteCodeUtilities @@ -102,9 +102,9 @@ public abstract class ByteCodeUtilities
102 * Get the first non-arg variable index based on the supplied arg array and whether to include the "this" reference, 102 * Get the first non-arg variable index based on the supplied arg array and whether to include the "this" reference,
103 * this corresponds to the size of the arguments passed in to the method plus an extra spot for "this" is specified 103 * this corresponds to the size of the arguments passed in to the method plus an extra spot for "this" is specified
104 104
105 - * @param args  
106 - * @param includeThis  
107 - * @return 105 + * @param args Method arguments
  106 + * @param includeThis Whether to include a slot for "this" (generally true for all non-static methods)
  107 + * @return first available local index which is NOT used by a method argument or "this"
108 */ 108 */
109 public static int getFirstNonArgLocalIndex(Type[] args, boolean includeThis) 109 public static int getFirstNonArgLocalIndex(Type[] args, boolean includeThis)
110 { 110 {
@@ -114,8 +114,8 @@ public abstract class ByteCodeUtilities @@ -114,8 +114,8 @@ public abstract class ByteCodeUtilities
114 /** 114 /**
115 * Get the size of the specified args array in local variable terms (eg. doubles and longs take two spaces) 115 * Get the size of the specified args array in local variable terms (eg. doubles and longs take two spaces)
116 * 116 *
117 - * @param args  
118 - * @return 117 + * @param args Method argument types as array
  118 + * @return size of the specified arguments array in terms of stack slots
119 */ 119 */
120 public static int getArgsSize(Type[] args) 120 public static int getArgsSize(Type[] args)
121 { 121 {
@@ -236,11 +236,11 @@ public abstract class ByteCodeUtilities @@ -236,11 +236,11 @@ public abstract class ByteCodeUtilities
236 * Attempts to locate the appropriate entry in the local variable table for the specified local variable index at the location 236 * Attempts to locate the appropriate entry in the local variable table for the specified local variable index at the location
237 * specified by node. 237 * specified by node.
238 * 238 *
239 - * @param classNode  
240 - * @param method  
241 - * @param node  
242 - * @param var  
243 - * @return 239 + * @param classNode Containing class
  240 + * @param method Method
  241 + * @param node Instruction defining the location to get the local variable table at
  242 + * @param var Local variable index
  243 + * @return a LocalVariableNode containing information about the local variable at the specified location in the specified local slot
244 */ 244 */
245 public static LocalVariableNode getLocalVariableAt(ClassNode classNode, MethodNode method, AbstractInsnNode node, int var) 245 public static LocalVariableNode getLocalVariableAt(ClassNode classNode, MethodNode method, AbstractInsnNode node, int var)
246 { 246 {
@@ -268,9 +268,8 @@ public abstract class ByteCodeUtilities @@ -268,9 +268,8 @@ public abstract class ByteCodeUtilities
268 * as part of the obfuscation process, we need to generate the local variable table when running obfuscated. We cache 268 * as part of the obfuscation process, we need to generate the local variable table when running obfuscated. We cache
269 * the generated tables so that we only need to do the relatively expensive calculation once per method we encounter. 269 * the generated tables so that we only need to do the relatively expensive calculation once per method we encounter.
270 * 270 *
271 - * @param classNode  
272 - * @param method  
273 - * @return 271 + * @param classNode Containing class
  272 + * @param method Method
274 */ 273 */
275 public static List<LocalVariableNode> getLocalVariableTable(ClassNode classNode, MethodNode method) 274 public static List<LocalVariableNode> getLocalVariableTable(ClassNode classNode, MethodNode method)
276 { 275 {
@@ -295,9 +294,8 @@ public abstract class ByteCodeUtilities @@ -295,9 +294,8 @@ public abstract class ByteCodeUtilities
295 /** 294 /**
296 * Use ASM Analyzer to generate the local variable table for the specified method 295 * Use ASM Analyzer to generate the local variable table for the specified method
297 * 296 *
298 - * @param classNode  
299 - * @param method  
300 - * @return 297 + * @param classNode Containing class
  298 + * @param method Method
301 */ 299 */
302 public static List<LocalVariableNode> generateLocalVariableTable(ClassNode classNode, MethodNode method) 300 public static List<LocalVariableNode> generateLocalVariableTable(ClassNode classNode, MethodNode method)
303 { 301 {
@@ -399,8 +397,8 @@ public abstract class ByteCodeUtilities @@ -399,8 +397,8 @@ public abstract class ByteCodeUtilities
399 /** 397 /**
400 * Get the source code name for the specified type 398 * Get the source code name for the specified type
401 * 399 *
402 - * @param type  
403 - * @return 400 + * @param type Type to generate a friendly name for
  401 + * @return String representation of the specified type, eg "int" for an integer primitive or "String" for java.lang.String
404 */ 402 */
405 public static String getTypeName(Type type) 403 public static String getTypeName(Type type)
406 { 404 {
@@ -427,9 +425,8 @@ public abstract class ByteCodeUtilities @@ -427,9 +425,8 @@ public abstract class ByteCodeUtilities
427 /** 425 /**
428 * Finds a method in the target class, uses names specified in the {@link Obfuscated} annotation if present 426 * Finds a method in the target class, uses names specified in the {@link Obfuscated} annotation if present
429 * 427 *
430 - * @param targetClass  
431 - * @param searchFor  
432 - * @return 428 + * @param targetClass Class to search in
  429 + * @param searchFor Method to search for
433 */ 430 */
434 public static MethodNode findTargetMethod(ClassNode targetClass, MethodNode searchFor) 431 public static MethodNode findTargetMethod(ClassNode targetClass, MethodNode searchFor)
435 { 432 {
@@ -458,9 +455,8 @@ public abstract class ByteCodeUtilities @@ -458,9 +455,8 @@ public abstract class ByteCodeUtilities
458 /** 455 /**
459 * Finds a field in the target class, uses names specified in the {@link Obfuscated} annotation if present 456 * Finds a field in the target class, uses names specified in the {@link Obfuscated} annotation if present
460 * 457 *
461 - * @param targetClass  
462 - * @param searchFor  
463 - * @return 458 + * @param targetClass Class to search in
  459 + * @param searchFor Field to search for
464 */ 460 */
465 public static FieldNode findTargetField(ClassNode targetClass, FieldNode searchFor) 461 public static FieldNode findTargetField(ClassNode targetClass, FieldNode searchFor)
466 { 462 {
@@ -488,10 +484,6 @@ public abstract class ByteCodeUtilities @@ -488,10 +484,6 @@ public abstract class ByteCodeUtilities
488 484
489 /** 485 /**
490 * Get an annotation of the specified class from the supplied field node 486 * Get an annotation of the specified class from the supplied field node
491 - *  
492 - * @param field  
493 - * @param annotationType  
494 - * @return  
495 */ 487 */
496 public static AnnotationNode getAnnotation(FieldNode field, Class<? extends Annotation> annotationClass) 488 public static AnnotationNode getAnnotation(FieldNode field, Class<? extends Annotation> annotationClass)
497 { 489 {
@@ -500,10 +492,6 @@ public abstract class ByteCodeUtilities @@ -500,10 +492,6 @@ public abstract class ByteCodeUtilities
500 492
501 /** 493 /**
502 * Get an annotation of the specified class from the supplied method node 494 * Get an annotation of the specified class from the supplied method node
503 - *  
504 - * @param method  
505 - * @param annotationType  
506 - * @return  
507 */ 495 */
508 public static AnnotationNode getAnnotation(MethodNode method, Class<? extends Annotation> annotationClass) 496 public static AnnotationNode getAnnotation(MethodNode method, Class<? extends Annotation> annotationClass)
509 { 497 {
@@ -511,9 +499,7 @@ public abstract class ByteCodeUtilities @@ -511,9 +499,7 @@ public abstract class ByteCodeUtilities
511 } 499 }
512 500
513 /** 501 /**
514 - * @param annotations  
515 - * @param annotationType  
516 - * @return 502 + * Get an annotation of the specified class from the supplied list of annotations, returns null if no matching annotation was found
517 */ 503 */
518 public static AnnotationNode getAnnotation(List<AnnotationNode> annotations, String annotationType) 504 public static AnnotationNode getAnnotation(List<AnnotationNode> annotations, String annotationType)
519 { 505 {
@@ -530,10 +516,9 @@ public abstract class ByteCodeUtilities @@ -530,10 +516,9 @@ public abstract class ByteCodeUtilities
530 } 516 }
531 517
532 /** 518 /**
533 - * Get the value of an annotation node 519 + * Get the value of an annotation node (the value at key "value")
534 * 520 *
535 - * @param annotation  
536 - * @return 521 + * @param annotation Annotation node to inspect
537 */ 522 */
538 public static <T> T getAnnotationValue(AnnotationNode annotation) 523 public static <T> T getAnnotationValue(AnnotationNode annotation)
539 { 524 {
@@ -541,9 +526,10 @@ public abstract class ByteCodeUtilities @@ -541,9 +526,10 @@ public abstract class ByteCodeUtilities
541 } 526 }
542 527
543 /** 528 /**
  529 + * Get the value of an annotation node
  530 + *
544 * @param annotation 531 * @param annotation
545 * @param key 532 * @param key
546 - * @return  
547 */ 533 */
548 @SuppressWarnings("unchecked") 534 @SuppressWarnings("unchecked")
549 public static <T> T getAnnotationValue(AnnotationNode annotation, String key) 535 public static <T> T getAnnotationValue(AnnotationNode annotation, String key)
java/common/com/mumfrey/liteloader/transformers/Callback.java
@@ -277,7 +277,6 @@ public class Callback @@ -277,7 +277,6 @@ public class Callback
277 /** 277 /**
278 * @param returnType 278 * @param returnType
279 * @param args 279 * @param args
280 - * @return  
281 */ 280 */
282 public static String generateDescriptor(Type returnType, Object... args) 281 public static String generateDescriptor(Type returnType, Object... args)
283 { 282 {
@@ -287,7 +286,6 @@ public class Callback @@ -287,7 +286,6 @@ public class Callback
287 /** 286 /**
288 * @param returnType 287 * @param returnType
289 * @param args 288 * @param args
290 - * @return  
291 */ 289 */
292 public static String generateDescriptor(Obf returnType, Object... args) 290 public static String generateDescriptor(Obf returnType, Object... args)
293 { 291 {
@@ -297,7 +295,6 @@ public class Callback @@ -297,7 +295,6 @@ public class Callback
297 /** 295 /**
298 * @param returnType 296 * @param returnType
299 * @param args 297 * @param args
300 - * @return  
301 */ 298 */
302 public static String generateDescriptor(String returnType, Object... args) 299 public static String generateDescriptor(String returnType, Object... args)
303 { 300 {
@@ -308,7 +305,6 @@ public class Callback @@ -308,7 +305,6 @@ public class Callback
308 * @param obfType 305 * @param obfType
309 * @param returnType 306 * @param returnType
310 * @param args 307 * @param args
311 - * @return  
312 */ 308 */
313 public static String generateDescriptor(int obfType, Object returnType, Object... args) 309 public static String generateDescriptor(int obfType, Object returnType, Object... args)
314 { 310 {
java/common/com/mumfrey/liteloader/transformers/ClassOverlayTransformer.java
@@ -31,7 +31,7 @@ import com.mumfrey.liteloader.util.log.LiteLoaderLogger; @@ -31,7 +31,7 @@ import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
31 /** 31 /**
32 * This transformer applies one class to another as an "overlay". This works by merging down and replacing all 32 * This transformer applies one class to another as an "overlay". This works by merging down and replacing all
33 * methods and fields from the "overlay" class into the "target" class being transformed. Fields and methods 33 * methods and fields from the "overlay" class into the "target" class being transformed. Fields and methods
34 - * marked with the {@link Obfuscate} annotation will search through the list of provided names to find a 34 + * marked with the {@link Obfuscated} annotation will search through the list of provided names to find a
35 * matching member in the target class, this allows methods and fields in the target class to be referenced 35 * matching member in the target class, this allows methods and fields in the target class to be referenced
36 * even if they have different names after obfuscation. 36 * even if they have different names after obfuscation.
37 * 37 *
@@ -110,8 +110,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer @@ -110,8 +110,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
110 protected boolean setSourceFile = true; 110 protected boolean setSourceFile = true;
111 111
112 /** 112 /**
113 - * @param targetClassName  
114 - * @param targetClassNameObf  
115 * @param overlayClassName 113 * @param overlayClassName
116 */ 114 */
117 protected ClassOverlayTransformer(String overlayClassName) 115 protected ClassOverlayTransformer(String overlayClassName)
@@ -197,7 +195,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer @@ -197,7 +195,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
197 * 195 *
198 * @param transformedName 196 * @param transformedName
199 * @param classBytes 197 * @param classBytes
200 - * @return  
201 */ 198 */
202 protected byte[] applyOverlay(String transformedName, byte[] classBytes) 199 protected byte[] applyOverlay(String transformedName, byte[] classBytes)
203 { 200 {
@@ -379,7 +376,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer @@ -379,7 +376,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
379 * @param method 376 * @param method
380 * @param fromClass 377 * @param fromClass
381 * @param toClass 378 * @param toClass
382 - * @return  
383 */ 379 */
384 private void transformMethod(MethodNode method, String fromClass, String toClass) 380 private void transformMethod(MethodNode method, String fromClass, String toClass)
385 { 381 {
java/common/com/mumfrey/liteloader/transformers/ClassTransformer.java
@@ -20,7 +20,6 @@ public abstract class ClassTransformer implements IClassTransformer @@ -20,7 +20,6 @@ public abstract class ClassTransformer implements IClassTransformer
20 20
21 /** 21 /**
22 * @param basicClass 22 * @param basicClass
23 - * @return  
24 */ 23 */
25 protected final ClassNode readClass(byte[] basicClass, boolean cacheReader) 24 protected final ClassNode readClass(byte[] basicClass, boolean cacheReader)
26 { 25 {
@@ -34,7 +33,6 @@ public abstract class ClassTransformer implements IClassTransformer @@ -34,7 +33,6 @@ public abstract class ClassTransformer implements IClassTransformer
34 33
35 /** 34 /**
36 * @param classNode 35 * @param classNode
37 - * @return  
38 */ 36 */
39 protected final byte[] writeClass(ClassNode classNode) 37 protected final byte[] writeClass(ClassNode classNode)
40 { 38 {
java/common/com/mumfrey/liteloader/transformers/event/Event.java
@@ -118,7 +118,7 @@ public class Event implements Comparable&lt;Event&gt; @@ -118,7 +118,7 @@ public class Event implements Comparable&lt;Event&gt;
118 * the existing event is returned instead. 118 * the existing event is returned instead.
119 * 119 *
120 * @param name Event name (case insensitive) 120 * @param name Event name (case insensitive)
121 - * @return 121 + * @return new Event instance or existing Event instance
122 */ 122 */
123 public static Event getOrCreate(String name) 123 public static Event getOrCreate(String name)
124 { 124 {
@@ -131,7 +131,7 @@ public class Event implements Comparable&lt;Event&gt; @@ -131,7 +131,7 @@ public class Event implements Comparable&lt;Event&gt;
131 * 131 *
132 * @param name Event name (case insensitive) 132 * @param name Event name (case insensitive)
133 * @param cancellable True if the event should be created as cancellable 133 * @param cancellable True if the event should be created as cancellable
134 - * @return 134 + * @return new Event instance or existing Event instance
135 */ 135 */
136 public static Event getOrCreate(String name, boolean cancellable) 136 public static Event getOrCreate(String name, boolean cancellable)
137 { 137 {
@@ -145,7 +145,7 @@ public class Event implements Comparable&lt;Event&gt; @@ -145,7 +145,7 @@ public class Event implements Comparable&lt;Event&gt;
145 * @param name Event name (case insensitive) 145 * @param name Event name (case insensitive)
146 * @param cancellable True if the event should be created as cancellable 146 * @param cancellable True if the event should be created as cancellable
147 * @param priority Priority for the event, only used when multiple events are being injected at the same instruction 147 * @param priority Priority for the event, only used when multiple events are being injected at the same instruction
148 - * @return 148 + * @return new Event instance or existing Event instance
149 */ 149 */
150 public static Event getOrCreate(String name, boolean cancellable, int priority) 150 public static Event getOrCreate(String name, boolean cancellable, int priority)
151 { 151 {
java/common/com/mumfrey/liteloader/transformers/event/EventInfo.java
@@ -92,9 +92,7 @@ public class EventInfo&lt;S&gt; implements Cancellable @@ -92,9 +92,7 @@ public class EventInfo&lt;S&gt; implements Cancellable
92 } 92 }
93 93
94 /** 94 /**
95 - * @param returnsVoid  
96 - * @param isStatic  
97 - * @return 95 + * @param returnType
98 */ 96 */
99 protected static String getEventInfoClassName(Type returnType) 97 protected static String getEventInfoClassName(Type returnType)
100 { 98 {
java/common/com/mumfrey/liteloader/transformers/event/InjectionPoint.java
@@ -43,7 +43,7 @@ public abstract class InjectionPoint @@ -43,7 +43,7 @@ public abstract class InjectionPoint
43 * @param insns Insn list to search in, the strategy MUST ONLY add nodes from this list to the {@code nodes} collection 43 * @param insns Insn list to search in, the strategy MUST ONLY add nodes from this list to the {@code nodes} collection
44 * @param nodes Collection of nodes to populate. Injectors should NOT make any assumptions about the state of this collection and should only call add() 44 * @param nodes Collection of nodes to populate. Injectors should NOT make any assumptions about the state of this collection and should only call add()
45 * @param event Event being injected here, supplied to allow alteration of behaviour for specific event configurations (eg. cancellable) 45 * @param event Event being injected here, supplied to allow alteration of behaviour for specific event configurations (eg. cancellable)
46 - * @return 46 + * @return true if one or more injection points were found
47 */ 47 */
48 public abstract boolean find(String desc, InsnList insns, Collection<AbstractInsnNode> nodes, Event event); 48 public abstract boolean find(String desc, InsnList insns, Collection<AbstractInsnNode> nodes, Event event);
49 49
@@ -51,7 +51,7 @@ public abstract class InjectionPoint @@ -51,7 +51,7 @@ public abstract class InjectionPoint
51 * Set whether this injection point should capture local variables as well as method arguments 51 * Set whether this injection point should capture local variables as well as method arguments
52 * 52 *
53 * @param captureLocals 53 * @param captureLocals
54 - * @return 54 + * @return this, for fluent interface
55 */ 55 */
56 public InjectionPoint setCaptureLocals(boolean captureLocals) 56 public InjectionPoint setCaptureLocals(boolean captureLocals)
57 { 57 {
@@ -72,7 +72,7 @@ public abstract class InjectionPoint @@ -72,7 +72,7 @@ public abstract class InjectionPoint
72 * injection point to dump the locals to the debug log at injection time. 72 * injection point to dump the locals to the debug log at injection time.
73 * 73 *
74 * @param logLocals 74 * @param logLocals
75 - * @return 75 + * @return this, for fluent interface
76 */ 76 */
77 public InjectionPoint setLogLocals(boolean logLocals) 77 public InjectionPoint setLogLocals(boolean logLocals)
78 { 78 {
@@ -81,7 +81,7 @@ public abstract class InjectionPoint @@ -81,7 +81,7 @@ public abstract class InjectionPoint
81 } 81 }
82 82
83 /** 83 /**
84 - * @return 84 + * Get whether log locals is enabled
85 */ 85 */
86 public boolean logLocals() 86 public boolean logLocals()
87 { 87 {
@@ -263,7 +263,6 @@ public abstract class InjectionPoint @@ -263,7 +263,6 @@ public abstract class InjectionPoint
263 * injection points 263 * injection points
264 * 264 *
265 * @param operands 265 * @param operands
266 - * @return  
267 */ 266 */
268 public static InjectionPoint and(InjectionPoint... operands) 267 public static InjectionPoint and(InjectionPoint... operands)
269 { 268 {
@@ -275,7 +274,6 @@ public abstract class InjectionPoint @@ -275,7 +274,6 @@ public abstract class InjectionPoint
275 * injection points 274 * injection points
276 * 275 *
277 * @param operands 276 * @param operands
278 - * @return  
279 */ 277 */
280 public static InjectionPoint or(InjectionPoint... operands) 278 public static InjectionPoint or(InjectionPoint... operands)
281 { 279 {
@@ -286,7 +284,6 @@ public abstract class InjectionPoint @@ -286,7 +284,6 @@ public abstract class InjectionPoint
286 * Returns an injection point which returns all insns immediately following insns from the supplied injection point 284 * Returns an injection point which returns all insns immediately following insns from the supplied injection point
287 * 285 *
288 * @param point 286 * @param point
289 - * @return  
290 */ 287 */
291 public static InjectionPoint after(InjectionPoint point) 288 public static InjectionPoint after(InjectionPoint point)
292 { 289 {
@@ -297,7 +294,6 @@ public abstract class InjectionPoint @@ -297,7 +294,6 @@ public abstract class InjectionPoint
297 * Returns an injection point which returns all insns immediately prior to insns from the supplied injection point 294 * Returns an injection point which returns all insns immediately prior to insns from the supplied injection point
298 * 295 *
299 * @param point 296 * @param point
300 - * @return  
301 */ 297 */
302 public static InjectionPoint before(InjectionPoint point) 298 public static InjectionPoint before(InjectionPoint point)
303 { 299 {
@@ -308,7 +304,6 @@ public abstract class InjectionPoint @@ -308,7 +304,6 @@ public abstract class InjectionPoint
308 * Returns an injection point which returns all insns offset by the specified "count" from insns from the supplied injection point 304 * Returns an injection point which returns all insns offset by the specified "count" from insns from the supplied injection point
309 * 305 *
310 * @param point 306 * @param point
311 - * @return  
312 */ 307 */
313 public static InjectionPoint shift(InjectionPoint point, int count) 308 public static InjectionPoint shift(InjectionPoint point, int count)
314 { 309 {
java/common/com/mumfrey/liteloader/transformers/event/MethodInfo.java
@@ -285,7 +285,6 @@ public class MethodInfo @@ -285,7 +285,6 @@ public class MethodInfo
285 * Get the signature (combined method name and descriptor) for the method represented by this methodInfo 285 * Get the signature (combined method name and descriptor) for the method represented by this methodInfo
286 * 286 *
287 * @param type Obfuscation type to use 287 * @param type Obfuscation type to use
288 - * @return  
289 */ 288 */
290 public String getSignature(int type) 289 public String getSignature(int type)
291 { 290 {
java/common/com/mumfrey/liteloader/transformers/event/inject/BeforeInvoke.java
@@ -95,7 +95,7 @@ public class BeforeInvoke extends InjectionPoint @@ -95,7 +95,7 @@ public class BeforeInvoke extends InjectionPoint
95 /** 95 /**
96 * Match the specified invokation of the specified method 96 * Match the specified invokation of the specified method
97 * 97 *
98 - * @param methodNames Method names to search for 98 + * @param methodName Method name to search for
99 * @param ordinal ID of the invokation to hook, or -1 to hook all invokations 99 * @param ordinal ID of the invokation to hook, or -1 to hook all invokations
100 */ 100 */
101 public BeforeInvoke(String methodName, int ordinal) 101 public BeforeInvoke(String methodName, int ordinal)
java/common/com/mumfrey/liteloader/transformers/event/json/JsonDescriptor.java
@@ -61,7 +61,7 @@ public class JsonDescriptor implements Serializable @@ -61,7 +61,7 @@ public class JsonDescriptor implements Serializable
61 61
62 /** 62 /**
63 * @param obfTable 63 * @param obfTable
64 - * @return 64 + * @return MethodInfo for this descriptor
65 */ 65 */
66 public MethodInfo parse(JsonObfuscationTable obfTable) 66 public MethodInfo parse(JsonObfuscationTable obfTable)
67 { 67 {
java/common/com/mumfrey/liteloader/transformers/event/json/JsonEvent.java
@@ -134,8 +134,8 @@ public class JsonEvent implements Serializable @@ -134,8 +134,8 @@ public class JsonEvent implements Serializable
134 } 134 }
135 135
136 /** 136 /**
137 - * @param transformer  
138 - * @return 137 + * @param transformer Transformer to register events with
  138 + * @return Event which was registered
139 */ 139 */
140 public Event register(ModEventInjectionTransformer transformer) 140 public Event register(ModEventInjectionTransformer transformer)
141 { 141 {
java/common/com/mumfrey/liteloader/transformers/event/json/JsonEvents.java
@@ -128,7 +128,7 @@ public class JsonEvents implements Serializable @@ -128,7 +128,7 @@ public class JsonEvents implements Serializable
128 * Parse a new JsonEvents object from the supplied JSON string 128 * Parse a new JsonEvents object from the supplied JSON string
129 * 129 *
130 * @param json 130 * @param json
131 - * @return 131 + * @return new JsonEvents instance
132 * @throws InvalidEventJsonException if the JSON ins invalid 132 * @throws InvalidEventJsonException if the JSON ins invalid
133 */ 133 */
134 public static JsonEvents parse(String json) throws InvalidEventJsonException 134 public static JsonEvents parse(String json) throws InvalidEventJsonException
java/common/com/mumfrey/liteloader/transformers/event/json/JsonMethods.java
@@ -59,7 +59,6 @@ public class JsonMethods @@ -59,7 +59,6 @@ public class JsonMethods
59 * Fetches a method descriptor by token 59 * Fetches a method descriptor by token
60 * 60 *
61 * @param token 61 * @param token
62 - * @return  
63 */ 62 */
64 public MethodInfo get(String token) 63 public MethodInfo get(String token)
65 { 64 {
java/common/com/mumfrey/liteloader/transformers/event/json/JsonObfuscationTable.java
@@ -91,7 +91,6 @@ public class JsonObfuscationTable implements Serializable @@ -91,7 +91,6 @@ public class JsonObfuscationTable implements Serializable
91 91
92 /** 92 /**
93 * @param token 93 * @param token
94 - * @return  
95 */ 94 */
96 public Obf parseClass(String token) 95 public Obf parseClass(String token)
97 { 96 {
@@ -100,7 +99,6 @@ public class JsonObfuscationTable implements Serializable @@ -100,7 +99,6 @@ public class JsonObfuscationTable implements Serializable
100 99
101 /** 100 /**
102 * @param token 101 * @param token
103 - * @return  
104 */ 102 */
105 public Obf parseMethod(String token) 103 public Obf parseMethod(String token)
106 { 104 {
@@ -109,7 +107,6 @@ public class JsonObfuscationTable implements Serializable @@ -109,7 +107,6 @@ public class JsonObfuscationTable implements Serializable
109 107
110 /** 108 /**
111 * @param token 109 * @param token
112 - * @return  
113 */ 110 */
114 public Obf parseField(String token) 111 public Obf parseField(String token)
115 { 112 {
@@ -119,7 +116,6 @@ public class JsonObfuscationTable implements Serializable @@ -119,7 +116,6 @@ public class JsonObfuscationTable implements Serializable
119 /** 116 /**
120 * @param token 117 * @param token
121 * @param obfs 118 * @param obfs
122 - * @return  
123 */ 119 */
124 private Obf parseObf(String token, Map<String, Obf> obfs) 120 private Obf parseObf(String token, Map<String, Obf> obfs)
125 { 121 {
java/common/com/mumfrey/liteloader/util/Input.java
@@ -274,7 +274,6 @@ public final class Input implements CoreProvider @@ -274,7 +274,6 @@ public final class Input implements CoreProvider
274 * 274 *
275 * @param descriptor 275 * @param descriptor
276 * @param handler 276 * @param handler
277 - * @return  
278 */ 277 */
279 public InputEvent getEvent(String descriptor, InputHandler handler) 278 public InputEvent getEvent(String descriptor, InputHandler handler)
280 { 279 {
@@ -289,7 +288,6 @@ public final class Input implements CoreProvider @@ -289,7 +288,6 @@ public final class Input implements CoreProvider
289 * 288 *
290 * @param descriptor 289 * @param descriptor
291 * @param handler 290 * @param handler
292 - * @return  
293 */ 291 */
294 public InputEvent[] getEvents(String descriptor, InputHandler handler) 292 public InputEvent[] getEvents(String descriptor, InputHandler handler)
295 { 293 {
java/common/com/mumfrey/liteloader/util/InputEvent.java
@@ -122,17 +122,11 @@ public class InputEvent @@ -122,17 +122,11 @@ public class InputEvent
122 if (this.next != null) this.next.onButtonEvent(pressed); 122 if (this.next != null) this.next.onButtonEvent(pressed);
123 } 123 }
124 124
125 - /**  
126 - * @return  
127 - */  
128 public Controller getController() 125 public Controller getController()
129 { 126 {
130 return this.controller; 127 return this.controller;
131 } 128 }
132 129
133 - /**  
134 - * @return  
135 - */  
136 public Component getComponent() 130 public Component getComponent()
137 { 131 {
138 return this.component; 132 return this.component;
java/common/com/mumfrey/liteloader/util/jinput/ComponentRegistry.java
@@ -187,8 +187,8 @@ public class ComponentRegistry @@ -187,8 +187,8 @@ public class ComponentRegistry
187 * @param name 187 * @param name
188 * @param portType 188 * @param portType
189 * @param portNumber 189 * @param portNumber
190 - * @param componentA  
191 - * @return 190 + * @param component
  191 + * @param index
192 */ 192 */
193 public static String getDescriptor(String type, String name, String portType, int portNumber, String component, int index) 193 public static String getDescriptor(String type, String name, String portType, int portNumber, String component, int index)
194 { 194 {
@@ -200,7 +200,6 @@ public class ComponentRegistry @@ -200,7 +200,6 @@ public class ComponentRegistry
200 * @param controller 200 * @param controller
201 * @param component 201 * @param component
202 * @param index 202 * @param index
203 - * @return  
204 */ 203 */
205 private static String getDescriptor(String controller, String component, int index) 204 private static String getDescriptor(String controller, String component, int index)
206 { 205 {
@@ -210,9 +209,8 @@ public class ComponentRegistry @@ -210,9 +209,8 @@ public class ComponentRegistry
210 209
211 /** 210 /**
212 * @param controller 211 * @param controller
213 - * @return  
214 */ 212 */
215 - private static String getControllerPath(Controller controller) 213 + private static String getControllerPath(Controller controller)
216 { 214 {
217 return ComponentRegistry.getControllerPath( 215 return ComponentRegistry.getControllerPath(
218 controller.getType().toString().toLowerCase(), 216 controller.getType().toString().toLowerCase(),
@@ -227,7 +225,6 @@ public class ComponentRegistry @@ -227,7 +225,6 @@ public class ComponentRegistry
227 * @param name 225 * @param name
228 * @param portType 226 * @param portType
229 * @param portNumber 227 * @param portNumber
230 - * @return  
231 */ 228 */
232 public static String getControllerPath(String type, String name, String portType, int portNumber) 229 public static String getControllerPath(String type, String name, String portType, int portNumber)
233 { 230 {
java/common/com/mumfrey/liteloader/util/net/HttpStringRetriever.java
@@ -94,8 +94,6 @@ public class HttpStringRetriever extends Thread @@ -94,8 +94,6 @@ public class HttpStringRetriever extends Thread
94 94
95 /** 95 /**
96 * Create a new string retriever to be used synchronously 96 * Create a new string retriever to be used synchronously
97 - *  
98 - * @param url URL to download from  
99 */ 97 */
100 public HttpStringRetriever() 98 public HttpStringRetriever()
101 { 99 {
java/common/net/eq2online/permissions/ReplicatedPermissionsContainer.java
@@ -74,8 +74,6 @@ public class ReplicatedPermissionsContainer implements Serializable @@ -74,8 +74,6 @@ public class ReplicatedPermissionsContainer implements Serializable
74 74
75 /** 75 /**
76 * Serialise this container to a byte array for transmission to a remote host 76 * Serialise this container to a byte array for transmission to a remote host
77 - *  
78 - * @return  
79 */ 77 */
80 public byte[] getBytes() 78 public byte[] getBytes()
81 { 79 {