From ca86b3fe5595e14a60bd1323ca0fd52016e43c74 Mon Sep 17 00:00:00 2001 From: GabrielMagnus Date: Thu, 12 Mar 2020 11:15:03 +0100 Subject: [PATCH] Made documentation for BoardElementContainer.java --- .../objects/BoardElementContainer.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/main/java/inf112/fiasko/roborally/objects/BoardElementContainer.java b/src/main/java/inf112/fiasko/roborally/objects/BoardElementContainer.java index ca11f68..e120140 100644 --- a/src/main/java/inf112/fiasko/roborally/objects/BoardElementContainer.java +++ b/src/main/java/inf112/fiasko/roborally/objects/BoardElementContainer.java @@ -2,19 +2,36 @@ package inf112.fiasko.roborally.objects; import inf112.fiasko.roborally.element_properties.Position; +/** + * This class represents a type of object and its position + * @param The type of object + */ public class BoardElementContainer { K obj; Position pos; + /** + * Initializes the BoardElementContainer + * @param obj The object + * @param pos The position + */ BoardElementContainer(K obj, Position pos) { this.obj = obj; this.pos = pos; } + /** + * Gets the object + * @return object + */ public K getObject() { return obj; } + /** + * Gets the position + * @return position + */ public Position getPosition() { return pos; }