code cleanup

This commit is contained in:
Andrin Fassbind 2022-03-25 21:58:23 +01:00
parent 77652705dc
commit d08ebc0187
3 changed files with 7 additions and 0 deletions

View File

@ -33,6 +33,7 @@ public final class PositionVector {
/**
* Adds two PositionVectors (e.g. car position and velocity vector or two velocity vectors).
*
* @param vectorA A position or velocity vector
* @param vectorB A position or velocity vector
* @return A new PositionVector holding the result of the addition. If both
@ -45,6 +46,7 @@ public final class PositionVector {
/**
* Subtracts two PositionVectors (e.g. car position and velocity vector or two velocity vectors).
*
* @param vectorA A position or velocity vector
* @param vectorB A position or velocity vector
* @return A new PositionVector holding the result of the addition. If both
@ -58,6 +60,7 @@ public final class PositionVector {
/**
* Calculates the scalar product (Skalarprodukt) of two 2D vectors. The scalar product
* multiplies the lengths of the parallel components of the vectors.
*
* @param vectorA A position or velocity vector
* @param vectorB A position or velocity vector
* @return The scalar product (vectorA * vectorB). Since vectorA and
@ -75,6 +78,7 @@ public final class PositionVector {
/**
* Copy constructor
*
* @param other
*/
public PositionVector(final PositionVector other) {

View File

@ -11,6 +11,7 @@ public class DoNotMoveStrategy implements MoveStrategy {
/**
* This method will be used to return the next Direction for the car.
*
* @return a NONE Direction
*/
@Override

View File

@ -23,6 +23,7 @@ public class PathFinderMoveStrategy implements MoveStrategy {
/**
* Constructor which initialises the needed variables and creates the MoveList
*
* @param track track instance of the game
* @param carIndex index of the car which owns this moveStrategy
*/
@ -82,6 +83,7 @@ public class PathFinderMoveStrategy implements MoveStrategy {
/**
* Method to check if a State is already in List calculatedStates
*
* @param state the State which should be checked
* @return true if it is in List, false if it isn't in List
*/