From 8e1f9a3601f6b878a39310e736c1eac6d841c94b Mon Sep 17 00:00:00 2001 From: fodorpatrik2000 <fodorpatrik2000@sch.bme.hu> Date: Sun, 28 Mar 2021 19:04:00 +0200 Subject: [PATCH] New docs annotation --- src/projlab/Asteroid.java | 2 ++ src/projlab/Game.java | 4 +++- src/projlab/Portal.java | 6 +++++- src/projlab/Uranium.java | 2 ++ src/projlab/Visitable.java | 1 + 5 files changed, 13 insertions(+), 2 deletions(-) diff --git a/src/projlab/Asteroid.java b/src/projlab/Asteroid.java index 1320bdd3..942b3e3f 100644 --- a/src/projlab/Asteroid.java +++ b/src/projlab/Asteroid.java @@ -23,6 +23,7 @@ public class Asteroid extends Visitable { */ private boolean closeToSun; + @Docs(changed = true) private boolean hasBeenSolarFlaredThisRound; //TODO: javadoc /** @@ -382,6 +383,7 @@ public class Asteroid extends Visitable { * @param visitable a hozzáadandó meglátogatható objektum */ @Override + @Docs(changed = true) public boolean addNeighbour(Visitable visitable) { MagicLogger.call(this, visitable); neighbours.add(visitable); diff --git a/src/projlab/Game.java b/src/projlab/Game.java index 86ceb562..22cf8ddd 100644 --- a/src/projlab/Game.java +++ b/src/projlab/Game.java @@ -14,6 +14,7 @@ public class Game { private static final ArrayList<Ticker> tickables = new ArrayList<>(); + @Docs(changed = true) private static ArrayList<Asteroid> asteroids = new ArrayList<>(); /** @@ -137,7 +138,8 @@ public class Game { * Körönként van meghívva, amikor az adott objektumnak kell "lépnie" a körben. * Megnézi, hogy éppen van-e napvihar folyamatban. */ - public static void tick() { + @Docs(changed = true) + public static void tick() { //TODO: új javadoc MagicLogger.callStatic(Game.class); boolean randBool = Rand.newInt(0, 10) % 5 == 0; diff --git a/src/projlab/Portal.java b/src/projlab/Portal.java index 1a865811..6bb63ca9 100644 --- a/src/projlab/Portal.java +++ b/src/projlab/Portal.java @@ -9,6 +9,7 @@ import java.util.Map; @Docs(uml = "Portal <.. Recipe\nPortal ..> Pair", skipdep = "Asteroid") public class Portal extends Visitable { + @Docs(changed = true) private boolean isKerge; //TODO: javadoc /** @@ -104,6 +105,7 @@ public class Portal extends Visitable { } @Override + @Docs(changed = true) public void solarFlare(int range) { //TODO: javadoc MagicLogger.call(this, range); isKerge = true; @@ -127,6 +129,7 @@ public class Portal extends Visitable { } @Override + @Docs(changed = true) public void tick() { //TODO: javadoc MagicLogger.call(this); if(isKerge){ @@ -147,7 +150,8 @@ public class Portal extends Visitable { MagicLogger.ret(); } - public void setKerge(boolean isKerge){ + @Docs(changed = true) + public void setKerge(boolean isKerge){ //TODO: javadoc this.isKerge = isKerge; } } diff --git a/src/projlab/Uranium.java b/src/projlab/Uranium.java index 7fa54172..35b31d75 100644 --- a/src/projlab/Uranium.java +++ b/src/projlab/Uranium.java @@ -11,6 +11,7 @@ public class Uranium extends Material { */ private static int count; + @Docs(changed = true) private int exposed; public Uranium(){ @@ -36,6 +37,7 @@ public class Uranium extends Material { * @param asteroid az aszteroida */ @Override + @Docs(changed = true) public void nearToSunAndDrilled(Asteroid asteroid) { //TODO: új javadoc MagicLogger.call(this, asteroid); diff --git a/src/projlab/Visitable.java b/src/projlab/Visitable.java index 62166fc2..d53d31f9 100644 --- a/src/projlab/Visitable.java +++ b/src/projlab/Visitable.java @@ -56,5 +56,6 @@ public abstract class Visitable implements Ticker { return false; } + @Docs(changed = true) public abstract void solarFlare(int range); //TODO: javadoc } -- GitLab