From 2f13788663e9384bb175ef688408de16cbc7918b Mon Sep 17 00:00:00 2001 From: Adam NAILI Date: Wed, 10 Jan 2018 21:07:57 +0100 Subject: Updating javadoc and placing @author --- src/main/java/fr/umlv/java/wallj/context/Context.java | 2 ++ src/main/java/fr/umlv/java/wallj/context/Game.java | 1 + src/main/java/fr/umlv/java/wallj/context/GraphicsContext.java | 2 ++ src/main/java/fr/umlv/java/wallj/context/InputHandler.java | 2 ++ src/main/java/fr/umlv/java/wallj/context/ScreenManager.java | 2 ++ src/main/java/fr/umlv/java/wallj/event/AddBombEvent.java | 8 ++++++++ src/main/java/fr/umlv/java/wallj/event/ConfirmEvent.java | 5 +++++ src/main/java/fr/umlv/java/wallj/event/DropBombEvent.java | 5 +++++ src/main/java/fr/umlv/java/wallj/event/Event.java | 5 +++++ src/main/java/fr/umlv/java/wallj/event/GameEvent.java | 5 +++++ src/main/java/fr/umlv/java/wallj/event/InputEvent.java | 5 +++++ src/main/java/fr/umlv/java/wallj/event/MoveRobotEvent.java | 8 ++++++++ 12 files changed, 50 insertions(+) (limited to 'src/main/java') diff --git a/src/main/java/fr/umlv/java/wallj/context/Context.java b/src/main/java/fr/umlv/java/wallj/context/Context.java index de9c461..053bc8e 100644 --- a/src/main/java/fr/umlv/java/wallj/context/Context.java +++ b/src/main/java/fr/umlv/java/wallj/context/Context.java @@ -8,6 +8,8 @@ import java.util.Objects; /** * A context used to store the current state of the application at one tick + * + * @author Adam NAILI */ public final class Context { //TODO Class Context diff --git a/src/main/java/fr/umlv/java/wallj/context/Game.java b/src/main/java/fr/umlv/java/wallj/context/Game.java index 53f61b4..7ddac02 100644 --- a/src/main/java/fr/umlv/java/wallj/context/Game.java +++ b/src/main/java/fr/umlv/java/wallj/context/Game.java @@ -10,6 +10,7 @@ import java.util.Objects; /** * A game. + * @author Adam NAILI */ public final class Game { //TODO diff --git a/src/main/java/fr/umlv/java/wallj/context/GraphicsContext.java b/src/main/java/fr/umlv/java/wallj/context/GraphicsContext.java index 9d5ec0d..1fb07de 100644 --- a/src/main/java/fr/umlv/java/wallj/context/GraphicsContext.java +++ b/src/main/java/fr/umlv/java/wallj/context/GraphicsContext.java @@ -10,6 +10,8 @@ import java.util.Objects; /** * A context of the current graphic status of the application. + * + * @author Adam NAILI */ public final class GraphicsContext { //TODO Class GraphicsContext diff --git a/src/main/java/fr/umlv/java/wallj/context/InputHandler.java b/src/main/java/fr/umlv/java/wallj/context/InputHandler.java index e3546fa..637e94f 100644 --- a/src/main/java/fr/umlv/java/wallj/context/InputHandler.java +++ b/src/main/java/fr/umlv/java/wallj/context/InputHandler.java @@ -16,6 +16,8 @@ import java.util.Objects; /** * Treats the inputs from the keyboard and mouse provided by Zen 5 and creates Events meaningful for the game. + * + * @author Adam NAILI */ public final class InputHandler { //TODO Class InputHandler diff --git a/src/main/java/fr/umlv/java/wallj/context/ScreenManager.java b/src/main/java/fr/umlv/java/wallj/context/ScreenManager.java index d687246..2f28ac9 100644 --- a/src/main/java/fr/umlv/java/wallj/context/ScreenManager.java +++ b/src/main/java/fr/umlv/java/wallj/context/ScreenManager.java @@ -9,6 +9,8 @@ import java.util.Objects; /** * Cleans the GraphicsContext + * + * @author Adam NAILI */ public final class ScreenManager { //TODO Class ScreenManager diff --git a/src/main/java/fr/umlv/java/wallj/event/AddBombEvent.java b/src/main/java/fr/umlv/java/wallj/event/AddBombEvent.java index eef0329..10581ff 100644 --- a/src/main/java/fr/umlv/java/wallj/event/AddBombEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/AddBombEvent.java @@ -4,9 +4,17 @@ import fr.umlv.java.wallj.board.TileVec2; import java.util.Objects; +/** + * Event to put a bomb on the game board + * + * @author Adam NAILI + */ public final class AddBombEvent implements InputEvent { TileVec2 tileVec2; + /** + * @param tileVec2 a vector with coordinate relative to the tile + */ public AddBombEvent(TileVec2 tileVec2) { this.tileVec2 = Objects.requireNonNull(tileVec2); } diff --git a/src/main/java/fr/umlv/java/wallj/event/ConfirmEvent.java b/src/main/java/fr/umlv/java/wallj/event/ConfirmEvent.java index 16b0d8b..6f1e403 100644 --- a/src/main/java/fr/umlv/java/wallj/event/ConfirmEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/ConfirmEvent.java @@ -1,5 +1,10 @@ package fr.umlv.java.wallj.event; +/** + * Event coming from a confirmation action from the user + * + * @author Adam NAILI + */ public class ConfirmEvent implements InputEvent { //TODO Class ConfirmEvent } diff --git a/src/main/java/fr/umlv/java/wallj/event/DropBombEvent.java b/src/main/java/fr/umlv/java/wallj/event/DropBombEvent.java index d0ac956..4386288 100644 --- a/src/main/java/fr/umlv/java/wallj/event/DropBombEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/DropBombEvent.java @@ -1,5 +1,10 @@ package fr.umlv.java.wallj.event; +/** + * Event to signal that a bomb will be placed at the next tick + * + * @author Adam NAILI + */ public final class DropBombEvent implements InputEvent { //TODO Class DropBombEvent } diff --git a/src/main/java/fr/umlv/java/wallj/event/Event.java b/src/main/java/fr/umlv/java/wallj/event/Event.java index 034e345..77ce0df 100644 --- a/src/main/java/fr/umlv/java/wallj/event/Event.java +++ b/src/main/java/fr/umlv/java/wallj/event/Event.java @@ -1,4 +1,9 @@ package fr.umlv.java.wallj.event; +/** + * An application event + * + * @author Adam NAILI + */ public interface Event { } diff --git a/src/main/java/fr/umlv/java/wallj/event/GameEvent.java b/src/main/java/fr/umlv/java/wallj/event/GameEvent.java index 53381a7..2fe1281 100644 --- a/src/main/java/fr/umlv/java/wallj/event/GameEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/GameEvent.java @@ -1,5 +1,10 @@ package fr.umlv.java.wallj.event; +/** + * A game event + * + * @author Adam NAILI + */ public interface GameEvent extends Event{ } diff --git a/src/main/java/fr/umlv/java/wallj/event/InputEvent.java b/src/main/java/fr/umlv/java/wallj/event/InputEvent.java index 3452c66..d18cba0 100644 --- a/src/main/java/fr/umlv/java/wallj/event/InputEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/InputEvent.java @@ -1,5 +1,10 @@ package fr.umlv.java.wallj.event; +/** + * An event coming from inputs + * + * @author Adam NAILI + */ public interface InputEvent extends Event { } diff --git a/src/main/java/fr/umlv/java/wallj/event/MoveRobotEvent.java b/src/main/java/fr/umlv/java/wallj/event/MoveRobotEvent.java index 7b3e115..a8c9da2 100644 --- a/src/main/java/fr/umlv/java/wallj/event/MoveRobotEvent.java +++ b/src/main/java/fr/umlv/java/wallj/event/MoveRobotEvent.java @@ -4,10 +4,18 @@ import fr.umlv.java.wallj.board.TileVec2; import java.util.Objects; +/** + * Event to precise that the robot is supposed to move on the tile provided + * + * @author Adam NAILI + */ public class MoveRobotEvent implements InputEvent { //TODO Class MoveRobotEvent TileVec2 tileVec2; + /** + * @param tileVec2 the target tile + */ public MoveRobotEvent(TileVec2 tileVec2) { this.tileVec2 = Objects.requireNonNull(tileVec2); } -- cgit v1.2.3