diff --git a/src/main/java/electroblob/wizardry/Wizardry.java b/src/main/java/electroblob/wizardry/Wizardry.java index 6e5e1ab5..8fc5b236 100644 --- a/src/main/java/electroblob/wizardry/Wizardry.java +++ b/src/main/java/electroblob/wizardry/Wizardry.java @@ -31,6 +31,16 @@ import net.minecraftforge.fml.common.eventhandler.SubscribeEvent; import net.minecraftforge.fml.common.network.NetworkRegistry; import net.minecraftforge.fml.common.registry.GameRegistry; +/** + * "Electroblob's Wizardry adds an RPG-like system of spells to Minecraft, with the aim of being as playable as + * possible. No crazy constructs, no perk trees, no complex recipes - simply find spell books, cast spells, and master + * the arcane! - But you knew that, right?" + *
+ * Main mod class for Wizardry. Contains the logger and settings instances, along with all the other stuff that's normally + * in a main mod class. + * @author Electroblob + * @since Wizardry 1.0 + */ @Mod(modid = Wizardry.MODID, name = Wizardry.NAME, version = Wizardry.VERSION, guiFactory = "electroblob.wizardry.WizardryGuiFactory") public class Wizardry { diff --git a/src/main/java/electroblob/wizardry/util/MagicDamage.java b/src/main/java/electroblob/wizardry/util/MagicDamage.java index 4df3bccb..9d6ca61b 100644 --- a/src/main/java/electroblob/wizardry/util/MagicDamage.java +++ b/src/main/java/electroblob/wizardry/util/MagicDamage.java @@ -45,6 +45,8 @@ import net.minecraft.util.EntityDamageSource; // type 'attributes'. This is my attempt to collect all of these into a reasonably coherent system. /** + * "Ouch, that hurt!" + *
* As of wizardry 1.1, this class has replaced the damagesource-related methods in WizardryUtilities, allowing a * {@link DamageType} to be specified with the damage. The main reason for this is so that damage sources can fit with * the vanilla behaviour on armour enchantments and such like whilst still being classified as wizardry damage for the diff --git a/src/main/java/electroblob/wizardry/util/SpellModifiers.java b/src/main/java/electroblob/wizardry/util/SpellModifiers.java index 8e840226..bbb7c08c 100644 --- a/src/main/java/electroblob/wizardry/util/SpellModifiers.java +++ b/src/main/java/electroblob/wizardry/util/SpellModifiers.java @@ -12,6 +12,8 @@ import net.minecraft.nbt.NBTTagCompound; import net.minecraftforge.fml.common.network.ByteBufUtils; /** + * "{@code SpellModifiers} - modify all the things!" + *
* Object that wraps any number of spell modifiers into one, allowing for expandability within the Spell#cast methods. * This class is essentially a glorified {@link Map} which can be written to and read from a {@link ByteBuf}. It is * possible to calculate spell modifiers from wand NBT within the cast methods, but this is cumbersome and does not diff --git a/src/main/java/electroblob/wizardry/util/WandHelper.java b/src/main/java/electroblob/wizardry/util/WandHelper.java index d21aa8ac..6c47c18a 100644 --- a/src/main/java/electroblob/wizardry/util/WandHelper.java +++ b/src/main/java/electroblob/wizardry/util/WandHelper.java @@ -12,6 +12,8 @@ import net.minecraft.item.ItemStack; import net.minecraft.nbt.NBTTagCompound; /** + * "Never fear, {@code WandHelper} is here!" + *
* Much like {@link net.minecraft.enchantment.EnchantmentHelper EnchantmentHelper}, this class has some static methods * which allow cleaner and more concise interaction with the wand NBT data, which is quite a complex structure. Such * interaction previously resulted in rather verbose and repetitive code which was hard to read and even harder to diff --git a/src/main/java/electroblob/wizardry/util/WizardryUtilities.java b/src/main/java/electroblob/wizardry/util/WizardryUtilities.java index 1b18fe79..6fdf1f5e 100644 --- a/src/main/java/electroblob/wizardry/util/WizardryUtilities.java +++ b/src/main/java/electroblob/wizardry/util/WizardryUtilities.java @@ -59,6 +59,9 @@ import net.minecraftforge.fml.relauncher.Side; import net.minecraftforge.fml.relauncher.SideOnly; /** + * "Where do you put random but useful bits and pieces? {@code WizardryUtilities} of course - the 'stuff that doesn't + * fit anywhere else' class!" + *
* This class contains some useful static methods for use anywhere - items, entities, spells, events, blocks, etc. * Broadly speaking, these fall into the following categories: *