Commit 83e858f4 authored by Mamadou Saliou DIALLO's avatar Mamadou Saliou DIALLO

doc: perform classes documentation

parent 0ddaea71
......@@ -7,7 +7,7 @@ import fr.univnantes.alma.references.associations.BidirectionalManyToOne;
import fr.univnantes.alma.references.interfaces.ManyToOneAssociation;
/**
* Basic place card
* Basic place card.
*/
public abstract class BasicPlaceCard extends BasicCard implements PlaceCard {
......@@ -28,11 +28,12 @@ public abstract class BasicPlaceCard extends BasicCard implements PlaceCard {
/**
* Create new instance of place card.
* @param number cardNumber
* @param cardNumber card number
* @param cardName Card name
*/
public BasicPlaceCard(Integer number, String name) {
super(name);
this.number = number;
public BasicPlaceCard(Integer cardNumber, String cardName) {
super(cardName);
this.number = cardNumber;
handOwner = new BidirectionalManyToOne<>(this, Tracked::getHand);
discardOwner = new BidirectionalManyToOne<>(this, Tracked::getDiscard);
}
......@@ -41,7 +42,7 @@ public abstract class BasicPlaceCard extends BasicCard implements PlaceCard {
* {@inheritdoc}
*/
@Override
public abstract void applyEffect(final BoardGame boardGame);
public abstract void applyEffect(BoardGame boardGame);
/**
* {@inheritdoc}
......
......@@ -20,14 +20,14 @@ public abstract class BasicSurvivalCard extends BasicCard
private String phase;
/**
* Create new instance of survival card
* Create new instance of survival card.
*
* @param phase phase of game
* @param name card name
* @param gamePhase phase of game
* @param cardName card name
*/
public BasicSurvivalCard(String phase, String name) {
super(name);
this.phase = phase;
public BasicSurvivalCard(String gamePhase, String cardName) {
super(cardName);
this.phase = gamePhase;
}
/**
......
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class DodgeCard extends BasicSurvivalCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 3";
/**
* Card name.
*/
private static final String CARD_NAME = "Esquive";
/**
......@@ -21,7 +28,7 @@ public class DodgeCard extends BasicSurvivalCard {
* {@inheritdoc}
*/
@Override
public void applyEffect(BoardGame boardGame) {
public void applyEffect(final BoardGame boardGame) {
}
}
\ No newline at end of file
}
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class FlipFlopCard extends BasicSurvivalCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 4";
/**
* Card name.
*/
private static final String CARD_NAME = "Volte-face";
/**
......@@ -21,7 +28,7 @@ public class FlipFlopCard extends BasicSurvivalCard {
* {@inheritdoc}
*/
@Override
public void applyEffect(BoardGame boardGame) {
public void applyEffect(final BoardGame boardGame) {
}
}
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class RisposteCard extends BasicSurvivalCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 1";
/**
* Card name.
*/
private static final String CARD_NAME = "Riposte";
/**
......@@ -21,7 +28,7 @@ public class RisposteCard extends BasicSurvivalCard {
* {@inheritdoc}
*/
@Override
public void applyEffect(BoardGame boardGame) {
public void applyEffect(final BoardGame boardGame) {
}
}
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class VortexCard extends BasicSurvivalCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 2";
/**
* Card name.
*/
private static final String CARD_NAME = "Vortex";
/**
......@@ -21,7 +28,7 @@ public class VortexCard extends BasicSurvivalCard {
* {@inheritdoc}
*/
@Override
public void applyEffect(BoardGame boardGame) {
public void applyEffect(final BoardGame boardGame) {
}
}
......@@ -2,7 +2,6 @@ package fr.univnantes.alma.model.card.player.track;
import fr.univnantes.alma.model.card.BasicCard;
import fr.univnantes.alma.model.player.Creature;
import fr.univnantes.alma.model.player.Tracked;
import fr.univnantes.alma.references.associations.BidirectionalManyToOne;
import fr.univnantes.alma.references.interfaces.ManyToOneAssociation;
......@@ -35,12 +34,12 @@ public abstract class BasicTrackingCard extends BasicCard
/**
* Create new instance of tracking card
*
* @param phase phase of game
* @param name card name
* @param gamePhase phase of game
* @param cardName card name
*/
public BasicTrackingCard(String phase, String name) {
super(name);
this.phase = phase;
public BasicTrackingCard(String gamePhase, String cardName) {
super(cardName);
this.phase = gamePhase;
handOwner = new BidirectionalManyToOne<>(this, Creature::getHand);
discardOwner = new BidirectionalManyToOne<>(this, Creature::getDiscard);
}
......
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class FlashBackCard extends BasicTrackingCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase de la carte copiée";
/**
* Card name.
*/
private static final String CARD_NAME = "Flashback";
/**
......
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class ForceFieldCard extends BasicTrackingCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 1";
/**
* Card name.
*/
private static final String CARD_NAME = "Champ de force";
/**
......
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class MutationCard extends BasicTrackingCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 2";
/**
* Card name.
*/
private static final String CARD_NAME = "Mutation";
/**
......
......@@ -7,7 +7,14 @@ import fr.univnantes.alma.model.BoardGame;
*/
public class RelentlessnessCard extends BasicTrackingCard {
/**
* Phase of game.
*/
private static final String PHASE = "Phase 2";
/**
* Card name.
*/
private static final String CARD_NAME = "Acharnement";
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment