Improve JavaDoc links, fix some broken JavaDocs (#2833)

Improve JavaDoc links, fix broken JavaDocs
This commit is contained in:
mezz authored and LexManos committed 2016-05-29 14:05:07 -07:00
1 parent 9bb927dc64
commit 86baf7462f
62 files changed
+353 -163

No files matched your search

@@ -1694,18 +1694,18 @@ public class GuiConfigEntries extends GuiListExtended
public boolean enabled();
/**
* Handles user keystrokes for any GuiTextField objects in this entry. Call {@code GuiTextField.keyTyped()} for any GuiTextField
* Handles user keystrokes for any GuiTextField objects in this entry. Call {@link GuiTextField#textboxKeyTyped(char, int)} for any GuiTextField
* objects that should receive the input provided.
*/
public void keyTyped(char eventChar, int eventKey);
/**
* Call {@code GuiTextField.updateCursorCounter()} for any GuiTextField objects in this entry.
* Call {@link GuiTextField#updateCursorCounter()} for any GuiTextField objects in this entry.
*/
public void updateCursorCounter();
/**
* Call {@code GuiTextField.mouseClicked()} for and GuiTextField objects in this entry.
* Call {@link GuiTextField#mouseClicked(int, int, int)} for and GuiTextField objects in this entry.
*/
public void mouseClicked(int x, int y, int mouseEvent);
@@ -31,14 +31,26 @@ public interface IConfigElement
public boolean isProperty();
/**
* This method returns a class that implements {@code IConfigEntry} or null. This class MUST
* provide a constructor with the following parameter types: {@code GuiConfig}, {@code GuiConfigEntries}, {@code IConfigElement}
* This method returns a class that implements {@link IConfigEntry} or null. This class MUST
* provide a constructor with the following parameter types: {@link GuiConfig}, {@link GuiConfigEntries}, {@link IConfigElement}
*
* @see GuiConfigEntries.ListEntryBase
* @see GuiConfigEntries.StringEntry
* @see GuiConfigEntries.BooleanEntry
* @see GuiConfigEntries.DoubleEntry
* @see GuiConfigEntries.IntegerEntry
*/
public Class<? extends IConfigEntry> getConfigEntryClass();
/**
* This method returns a class that implements {@code IArrayEntry}. This class MUST provide a constructor with the
* following parameter types: {@code GuiEditArray}, {@code GuiEditArrayEntries}, {@code IConfigElement}, {@code Object}
* This method returns a class that implements {@link IArrayEntry}. This class MUST provide a constructor with the
* following parameter types: {@link GuiEditArray}, {@link GuiEditArrayEntries}, {@link IConfigElement}, {@link Object}
*
* @see GuiEditArrayEntries.BaseEntry
* @see GuiEditArrayEntries.StringEntry
* @see GuiEditArrayEntries.BooleanEntry
* @see GuiEditArrayEntries.DoubleEntry
* @see GuiEditArrayEntries.IntegerEntry
*/
public Class<? extends IArrayEntry> getArrayEntryClass();
@@ -49,9 +49,6 @@ public class RenderingRegistry
* Register an entity rendering handler. This will, after mod initialization, be inserted into the main
* render map for entities.
* Call this during Preinitialization phase.
*
* @param entityClass
* @param renderer
*/
public static <T extends Entity> void registerEntityRenderingHandler(Class<T> entityClass, IRenderFactory<? super T> renderFactory)
{