Update docs

Author: CrafterKina

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/block/IColorable.java

@@ -2,7 +2,7 @@
 
 /**
  * 着色可能Blockのインターフェースです。
- * <p/>
+ * <br>
  * Colorable Block Interface.
  *
  * @author CrafterKina

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/block/ICrop.java

@@ -5,11 +5,12 @@
 import net.minecraft.util.math.BlockPos;
 import net.minecraft.world.World;
 
+import javax.annotation.Nonnull;
 import java.util.Random;
 
 /**
  * 作物のインターフェースです。
- * <p/>
+ * <br>
  * Crop interface.
  *
  * @author CrafterKina
@@ -19,134 +20,102 @@
 public interface ICrop{
     /**
      * 作物が完熟している場合、trueを返します。 他の成長段階で収穫が異なっても、完熟した段階でのみtrueを返します。
-     * <p/>
+     * <br>
      * When the crop has grew completely, return true. Even If harvest-result changes by growth stage, only true in
      * final stage.
      *
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    boolean isMature(World world, BlockPos pos);
+    boolean isMature(@Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 作物から何らかの収穫が得られるときは、trueを返します。
-     * <p/>
+     * <br>
      * Whenever this crop drops any harvest-results, return true.
      *
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    boolean isHarvestable(World world, BlockPos pos);
+    boolean isHarvestable(@Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 収穫者がこの作物を収穫できるか判定します。
-     * <p/>
+     * <br>
      * The harvester can harvest.
      *
      * @param player
-     *         Nonnull
-     *         <p/>
      *         the Harvester
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    boolean canHarvestCrop(EntityPlayer player, World world, BlockPos pos);
+    boolean canHarvestCrop(@Nonnull EntityPlayer player, @Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 成長段階を一つ進めます。 それ以上成長できない場合、falseを返し何も行いません。
-     * <p/>
+     * <br>
      * Force raise up the growth-stage. If this crop can't grow more, return false and do not anything.
      *
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    boolean grow(World world, BlockPos pos);
+    boolean grow(@Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 作物の種を返します。
-     * <p/>
+     * <br>
      * Seed of Crop.
      *
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    ItemStack getSeed(World world, BlockPos pos);
+    ItemStack getSeed(@Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 期待されるすべての収穫物を返します。
-     * <p/>
+     * <br>
      * All excepted harvest-results.
      *
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    ItemStack[] getAllExceptedResult(World world, BlockPos pos);
+    @Nonnull
+    ItemStack[] getAllExceptedResult(@Nonnull World world, @Nonnull BlockPos pos);
 
     /**
      * 収穫結果を返します。ドロップ処理等は行いません。
-     * <p/>
+     * <br>
      * Return harvest-result items and do not any more.
      *
      * @param player
-     *         Nonnull
-     *         <p/>
      *         the Harvester
      * @param random
-     *         Nonnull
-     *         <p/>
      *         Randomize
      * @param world
-     *         Nonnull
-     *         <p/>
      *         the World
      * @param pos
-     *         Nonnull
-     *         <p/>
      *         position
      * @since 1.0
      */
-    ItemStack[] harvest(EntityPlayer player, Random random, World world, BlockPos pos);
+    @Nonnull
+    ItemStack[] harvest(@Nonnull EntityPlayer player, @Nonnull Random random, @Nonnull World world, @Nonnull BlockPos pos);
 
 }

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/block/IOre.java

@@ -2,7 +2,7 @@
 
 /**
  * 鉱石ブロックのインターフェースです。
- * <p/>
+ * <br>
  * Ore Block Interface.
  *
  * @author CrafterKina

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/entity/IBreedable.java

@@ -2,9 +2,11 @@
 
 import net.minecraft.item.ItemStack;
 
+import javax.annotation.Nonnull;
+
 /**
  * 繁殖可能なEntityのインターフェース
- * <p/>
+ * <br>
  * Breedable mobs interface.
  *
  * @author CrafterKina
@@ -14,11 +16,9 @@
 public interface IBreedable{
     /**
      * @param stack
-     *         CheckForNull
-     *         <p/>
      *         the Item
      * @see net.minecraft.entity.passive.EntityAnimal#isBreedingItem(ItemStack) it is same.
      * @since 1.0
      */
-    boolean canBreedBy(ItemStack stack);
+    boolean canBreedBy(@Nonnull ItemStack stack);
 }

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/entity/IRidden.java

@@ -2,6 +2,8 @@
 
 import net.minecraft.entity.Entity;
 
+import javax.annotation.Nonnull;
+
 /**
  * 乗れるEntityのインターフェース。
  * <p/>
@@ -14,39 +16,36 @@
 public interface IRidden{
     /**
      * 乗る。
-     * <p/>
+     * <br>
      * ride.
      *
      * @param entity
-     *         Nonnull
-     *         <p/>
      *         to ride
      * @return success
      * @since 1.0
      */
-    boolean ride(Entity entity);
+    boolean ride(@Nonnull Entity entity);
 
 
     /**
      * 降ろす。
-     * <p/>
+     * <br>
      * unload.
      *
      * @param entity
-     *         Nonnull
-     *         <p/>
      *         to unload
      * @return success
      * @since 1.0
      */
-    boolean unload(Entity entity);
+    boolean unload(@Nonnull Entity entity);
 
     /**
      * 乗っているすべてのEntityを返す。
-     * <p/>
+     * <br>
      * All the riding on this.
      *
      * @since 1.0
      */
+    @Nonnull
     Entity[] getRiddenBy();
 }

src/main/java/jp/MinecraftModderJapan/ModCooperationAPI/api/item/IBook.java

@@ -3,9 +3,11 @@
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.item.ItemStack;
 
+import javax.annotation.Nonnull;
+
 /**
  * 本のためのインターフェイス。
- * <p/>
+ * <br>
  * Interface for the book.
  *
  * @author Shift02
@@ -16,51 +18,43 @@ public interface IBook{
 
     /**
      * GUIを持っているか。
-     * <p/>
+     * <br>
      * the book has gui.
      *
      * @param book
-     *         Nonnull
-     *         <p/>
      *         Instance of the book stack.
      * @return 持っている場合はtrue If the book has, "true"
      * @since 1.0
      */
-    boolean hasGUI(ItemStack book);
+    boolean hasGUI(@Nonnull ItemStack book);
 
     /**
      * GUIを開けることができるか。
-     * <p/>
+     * <br>
      * player can open gui.
      *
      * @param player
-     *         Nonnull
-     *         <p/>
      *         the Player
      * @param book
-     *         Nonnull
-     *         <p/>
      *         Instance of the book stack.
      * @return 開くことができるならtrue。 If player can open gui, true.
      * @since 1.0
      */
-    boolean canOpenGUI(EntityPlayer player, ItemStack book);
+    boolean canOpenGUI(@Nonnull EntityPlayer player, @Nonnull ItemStack book);
 
     /**
      * GUIを開く。
-     * <p/>
+     * <br>
      * Open the GUI.
      *
      * @param player
-     *         Nonnull
-     *         <p/>
      *         the Player
      * @param book
-     *         Nonnull
-     *         <p/>
      *         Instance of the book stack.
+     * @return opened book stack
      * @since 1.0
      */
-    ItemStack openGUI(EntityPlayer player, ItemStack book);
+    @Nonnull
+    ItemStack openGUI(@Nonnull EntityPlayer player, @Nonnull ItemStack book);
 
 }