mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-20 04:09:51 +00:00
Improve JavaDoc links, fix some broken JavaDocs (#2833)
Improve JavaDoc links, fix broken JavaDocs
This commit is contained in:
1 parent
9bb927dc64
commit
86baf7462f
62 files changed
+353
-163
No files matched your search
@@ -140,7 +140,7 @@ public class BiomeDictionary
|
||||
* Registers a biome with a specific biome type
|
||||
*
|
||||
* @param biome the biome to be registered
|
||||
* @param type the type to register the biome as
|
||||
* @param types the types to register the biome as
|
||||
* @return returns true if the biome was registered successfully
|
||||
*/
|
||||
public static boolean registerBiomeType(BiomeGenBase biome, Type ... types)
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
package net.minecraftforge.common;
|
||||
|
||||
import net.minecraft.block.state.IBlockState;
|
||||
import net.minecraft.util.EnumFacing;
|
||||
import net.minecraft.util.math.BlockPos;
|
||||
import net.minecraft.world.IBlockAccess;
|
||||
import net.minecraftforge.common.util.EnumHelper;
|
||||
|
||||
public enum EnumPlantType
|
||||
@@ -14,16 +18,16 @@ public enum EnumPlantType
|
||||
|
||||
/**
|
||||
* Getting a custom {@link EnumPlantType}, or an existing one if it has the same name as that one. Your plant should implement {@link IPlantable}
|
||||
* and return this custom type in {@link IPlantable#getPlantType(net.minecraft.world.IBlockAccess, net.minecraft.util.BlockPos)}.
|
||||
* and return this custom type in {@link IPlantable#getPlantType(IBlockAccess, BlockPos)}.
|
||||
*
|
||||
* <p>If your new plant grows on blocks like any one of them above, never create a new {@link EnumPlantType}.
|
||||
* This enumeration is only functioning in
|
||||
* {@link net.minecraft.block.Block#canSustainPlant(net.minecraft.world.IBlockAccess, net.minecraft.util.BlockPos, net.minecraft.util.EnumFacing, IPlantable)},
|
||||
* {@link net.minecraft.block.Block#canSustainPlant(IBlockState, IBlockAccess, BlockPos, EnumFacing, IPlantable)},
|
||||
* which you are supposed to override this function in your new block and create a new plant type to grow on that block.
|
||||
*
|
||||
* <p>You can create an instance of your plant type in your API and let your/others mods access it. It will be faster than calling this method.
|
||||
* @param name the name of the type of plant, you had better follow the style above
|
||||
* @return the acquired {@EnumPlantType}, a new one if not found.
|
||||
* @return the acquired {@link EnumPlantType}, a new one if not found.
|
||||
*/
|
||||
public static EnumPlantType getPlantType(String name)
|
||||
{
|
||||
|
||||
@@ -55,7 +55,7 @@ public class Capability<T>
|
||||
* @param capability The Capability being stored.
|
||||
* @param instance An instance of that capabilities interface.
|
||||
* @param side The side of the object the instance is associated with.
|
||||
* @param A NBT holding the data. Must not be null, as doesn't make sense to call this function with nothing to read...
|
||||
* @param nbt A NBT holding the data. Must not be null, as doesn't make sense to call this function with nothing to read...
|
||||
*/
|
||||
void readNBT(Capability<T> capability, T instance, EnumFacing side, NBTBase nbt);
|
||||
}
|
||||
|
||||
@@ -60,7 +60,7 @@ public enum CapabilityManager
|
||||
*
|
||||
* @param type The Interface to be registered
|
||||
* @param storage A default implementation of the storage handler.
|
||||
* @param factor A Factory that will produce new instances of the default implementation.
|
||||
* @param factory A Factory that will produce new instances of the default implementation.
|
||||
*/
|
||||
public <T> void register(Class<T> type, Capability.IStorage<T> storage, Callable<? extends T> factory)
|
||||
{
|
||||
|
||||
@@ -36,7 +36,10 @@ import java.util.regex.Pattern;
|
||||
import com.google.common.base.CharMatcher;
|
||||
import com.google.common.collect.ImmutableSet;
|
||||
|
||||
import net.minecraftforge.fml.client.config.GuiConfig;
|
||||
import net.minecraftforge.fml.client.config.GuiConfigEntries;
|
||||
import net.minecraftforge.fml.client.config.GuiConfigEntries.IConfigEntry;
|
||||
import net.minecraftforge.fml.client.config.IConfigElement;
|
||||
import net.minecraftforge.fml.common.FMLLog;
|
||||
import net.minecraftforge.fml.common.Loader;
|
||||
import net.minecraftforge.fml.relauncher.FMLInjectionData;
|
||||
@@ -1215,9 +1218,15 @@ public class Configuration
|
||||
|
||||
/**
|
||||
* Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that
|
||||
* navigates into the category). This class MUST provide a constructor with the following parameter types: {@code GuiConfig} (the parent
|
||||
* GuiConfig screen will be provided), {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigElement}
|
||||
* navigates into the category). This class MUST provide a constructor with the following parameter types: {@link GuiConfig} (the parent
|
||||
* GuiConfig screen will be provided), {@link GuiConfigEntries} (the parent GuiConfigEntries will be provided), {@link IConfigElement}
|
||||
* (the IConfigElement for this Property will be provided).
|
||||
*
|
||||
* @see GuiConfigEntries.ListEntryBase
|
||||
* @see GuiConfigEntries.StringEntry
|
||||
* @see GuiConfigEntries.BooleanEntry
|
||||
* @see GuiConfigEntries.DoubleEntry
|
||||
* @see GuiConfigEntries.IntegerEntry
|
||||
*/
|
||||
public Configuration setCategoryConfigEntryClass(String category, Class<? extends IConfigEntry> clazz)
|
||||
{
|
||||
@@ -1561,7 +1570,7 @@ public class Configuration
|
||||
*
|
||||
* @param name Name of the property.
|
||||
* @param category Category of the property.
|
||||
* @param defaultValue Default value of the property.
|
||||
* @param defaultValues Default values of the property.
|
||||
* @param comment A brief description what the property does.
|
||||
* @return The value of the new string property.
|
||||
*/
|
||||
|
||||
@@ -9,8 +9,13 @@ import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import net.minecraftforge.fml.client.config.GuiConfig;
|
||||
import net.minecraftforge.fml.client.config.GuiConfigEntries;
|
||||
import net.minecraftforge.fml.client.config.GuiConfigEntries.IConfigEntry;
|
||||
import net.minecraftforge.fml.client.config.GuiEditArray;
|
||||
import net.minecraftforge.fml.client.config.GuiEditArrayEntries;
|
||||
import net.minecraftforge.fml.client.config.GuiEditArrayEntries.IArrayEntry;
|
||||
import net.minecraftforge.fml.client.config.IConfigElement;
|
||||
|
||||
public class Property
|
||||
{
|
||||
@@ -383,9 +388,15 @@ public class Property
|
||||
|
||||
/**
|
||||
* Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. This class
|
||||
* MUST provide a constructor with the following parameter types: {@code GuiConfig} (the owning GuiConfig screen will be provided),
|
||||
* {@code GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@code IConfigElement} (the IConfigElement for this Property
|
||||
* MUST provide a constructor with the following parameter types: {@link GuiConfig} (the owning GuiConfig screen will be provided),
|
||||
* {@link GuiConfigEntries} (the owning GuiConfigEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property
|
||||
* will be provided).
|
||||
*
|
||||
* @see GuiConfigEntries.ListEntryBase
|
||||
* @see GuiConfigEntries.StringEntry
|
||||
* @see GuiConfigEntries.BooleanEntry
|
||||
* @see GuiConfigEntries.DoubleEntry
|
||||
* @see GuiConfigEntries.IntegerEntry
|
||||
*/
|
||||
public Property setConfigEntryClass(Class<? extends IConfigEntry> clazz)
|
||||
{
|
||||
@@ -406,11 +417,15 @@ public class Property
|
||||
|
||||
/**
|
||||
* Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. This class
|
||||
* MUST provide a constructor with the following parameter types: {@code GuiEditList} (the owning GuiEditList screen will be provided),
|
||||
* {@code GuiPropertyList} (the parent GuiPropertyList will be provided), {@code IConfigProperty} (the IConfigProperty for this Property
|
||||
* will be provided).
|
||||
* MUST provide a constructor with the following parameter types: {@link GuiEditArray} (the owning GuiEditArray screen will be provided),
|
||||
* {@link GuiEditArrayEntries} (the parent GuiEditArrayEntries will be provided), {@link IConfigElement} (the IConfigElement for this Property
|
||||
* will be provided), and {@link Object} for the property's value.
|
||||
*
|
||||
* @param clazz a class that implements IConfigEntry
|
||||
* @see GuiEditArrayEntries.BaseEntry
|
||||
* @see GuiEditArrayEntries.StringEntry
|
||||
* @see GuiEditArrayEntries.BooleanEntry
|
||||
* @see GuiEditArrayEntries.DoubleEntry
|
||||
* @see GuiEditArrayEntries.IntegerEntry
|
||||
*/
|
||||
public Property setArrayEntryClass(Class<? extends IArrayEntry> clazz)
|
||||
{
|
||||
@@ -855,7 +870,6 @@ public class Property
|
||||
/**
|
||||
* Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
|
||||
*
|
||||
* @param _default The default to provide if the current value is not a valid double
|
||||
* @return The value
|
||||
*/
|
||||
public double getDouble()
|
||||
|
||||
Reference in new issue
Block a user