Merge pull request #42 from Team-13-RLC/generate-docs

Regenerated docs

Author: Pyrobow

core/src/com/dragonboatrace/entities/Collidable.java

@@ -67,13 +67,16 @@ public float getSpeed() {
 
     /**
      * Invoke the effect of the collidable on the boat.
+     *
+     * @param boat Which boat is affected
      */
     public void takeEffect(Boat boat) {
         effect.invoke(boat);
     }
 
     /**
      * Is the object a powerup or an obstacle
+     * @return true for powerup, false otherwise
      */
     public boolean isPowerup() {
         return type.ordinal() >= CollidableStats.POWERUPS_START_AT_INDEX;

core/src/com/dragonboatrace/screens/DifficultySelectScreen.java

@@ -54,7 +54,8 @@ public class DifficultySelectScreen implements Screen {
     /**
      * Creates a new screen to display the difficulty options to the player.
      *
-     * @param game The instance of the {@link DragonBoatRace} game.
+     * @param game     The instance of the {@link DragonBoatRace} game.
+     * @param boatType The boat type selected on the previous screen which is to be passed to the MainGameScreen
      */
     public DifficultySelectScreen(DragonBoatRace game, BoatType boatType) {
         this.game = game;

core/src/com/dragonboatrace/tools/CollidableEffect.java

@@ -5,7 +5,7 @@
 /**
  * Functional interface, used to name the type of the stored lambda expressions,
  * which dictate what the collidable does upon collision.
- * This is very similar to built in Consumer<T> interface.
+ * This is very similar to built in Consumer<T> interface.
  * However it does not allow the creation of a lambda taking any other parameter type.
  * It is also more clearly named.
  */