Diff: GameObjects/Snake/Snake-test.h

Revision:

101:5108621b207f

Parent:

99:4841f326200f

Child:

102:79d7bff6543f

--- a/GameObjects/Snake/Snake-test.h	Thu May 09 11:10:06 2019 +0000
+++ b/GameObjects/Snake/Snake-test.h	Thu May 09 11:23:16 2019 +0000
@@ -6,12 +6,52 @@
  */
  
 ///////////// prototypes //////////////
+ /**
+ * @brief Check that Snake object goes to correct position when moved and/ when collides.
+ * @returns true if all the tests passed.
+ */
+bool Snake_test_movement();
+
+ /**
+ * @brief Checks if that the snake gets initialised properly.
+ * @returns true if the test passed.
+ */
 bool check_initialisation();
+
+ /**
+ * @brief Checks that when the snake moves west, it updates as expected.
+ * @returns true if the test passed.
+ */
 bool check_west_movement();
+
+ /**
+ * @brief Checks that when the snake moves east, it updates as expected.
+ * @returns true if the test passed.
+ */
 bool check_east_movement();
+
+ /**
+ * @brief Checks that the snake properly freezes when the immobile_bead_n is disabled for all of them.
+ * @returns true if the test passed.
+ */
 bool check_freeze_movement();
+
+ /**
+ * @brief Checks that the snake properly exhibits chain reaction.
+ * @returns true if the test passed.
+ */
 bool check_chain_reaction();
+
+ /**
+ * @brief Checks that the snake length reduces accordingly when a block collision is simulated
+ * @returns true if the test passed.
+ */
 bool check_block_collision_and_relative_movement();
+
+ /**
+ * @brief Checks that the snake length increases accordingly when a food collision is simulated
+ * @returns true if the test passed.
+ */
 bool check_food_collision_and_relative_movement();
 
 /////////////// object ///////////////