Start functions documentation.

[Project_algorithmic_C.git] / lib / othello.c

diff --git a/lib/othello.c b/lib/othello.c
index 1bc32e2fe1969b082424ab00bfa8af89845b10c6..4f65659af0ef1f4590e4d91a14210dc297d6490f 100644 (file)
--- a/lib/othello.c
+++ b/lib/othello.c
@@ -23,6 +23,11 @@
 #include "othello.h"
 #include "debug.h"
 
+/**
+ * Get current round player integer
+ * @param  round_count current round integer
+ * @return             current round player
+ */
 unsigned int current_player(unsigned int round_count) {
 
     if (round_count % 2 != 0) {
@@ -32,6 +37,11 @@ unsigned int current_player(unsigned int round_count) {
     }
 }
 
+/**
+ * Get current round opponent integer
+ * @param  current_player current round player
+ * @return                current round opponent integer
+ */
 unsigned int current_opponent(unsigned int current_player) {
 
     if (current_player == player_one) {
@@ -49,6 +59,13 @@ unsigned int current_opponent(unsigned int current_player) {
  * v
  * The origin O has (1, 1) coordinates */
 
+/**
+ * Get pawn value at coordinates (x,y)
+ * @param  y          y coordinate
+ * @param  x          x coordinate
+ * @param  pawn_array array of played pawns
+ * @return            pawn integer type
+ */
 unsigned int get_box_value(int y, int x, unsigned int pawn_array[board_size][board_size]) {
 
     return pawn_array[y-1][x-1];
@@ -218,8 +235,8 @@ static unsigned int reverse_one_direction(int y, int x, int direction, unsigned
     return nb_pawns_reversed;
 }
 
-/* loop optimized version of valid_shot changing nothing to the pawns 2D array */
-static bool is_legal_shot(int y, int x, unsigned int current_player, unsigned int pawn_array[board_size][board_size]) {
+/* loop optimized version of valid_shot function changing nothing to the pawns 2D array */
+bool is_legal_shot(int y, int x, unsigned int current_player, unsigned int pawn_array[board_size][board_size]) {
     unsigned int nb_pawns_reversed = 0;
 
     if (!is_valid_coordinates(y, x) || !is_box_type(y, x, pawn_array, empty)) {
@@ -256,7 +273,7 @@ unsigned int valid_shot(int y, int x, unsigned int current_player, unsigned int
 }
 
 static void add_shots_list_cell(int y, int x, unsigned int type, struct shots_list_s* shots_list) {
-    struct shots_list_s* list_cell = malloc(sizeof(struct shots_list_s));
+    struct shots_list_s* list_cell = (struct shots_list_s*)malloc(sizeof(struct shots_list_s));
     if (!list_cell) {
         exit(EXIT_FAILURE);
     }
@@ -274,7 +291,7 @@ void free_shots_list(struct shots_list_s* shots_list) {
 
     while (!list_empty(&shots_list->list)) {
         list_counter = list_entry(shots_list->list.next, struct shots_list_s, list);
-        list_del(&list_counter->list);
+        list_del(&(list_counter->list));
         free(list_counter);
     }