Refine a bit .cquery and .gitignore.

[Project_algorithmic_C.git] / lib / othello.c

diff --git a/lib/othello.c b/lib/othello.c
index 14c1a9b8c883305a943fbf0f7ee3048f09c0c7d7..6c03f1dacaa7acbc57c3d55ad51df6e866257b6f 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,7 +37,12 @@ unsigned int current_player(unsigned int round_count) {
     }
 }
 
-unsigned int current_opponent(unsigned int current_player) {
+/**
+ * Get current round opponent integer
+ * @param  current_player current round player
+ * @return                current round opponent integer
+ */
+static unsigned int current_opponent(unsigned int current_player) {
 
     if (current_player == player_one) {
         return player_two;
@@ -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 (y,x)
+ * @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];
@@ -76,7 +93,13 @@ static bool is_valid_coordinates(int y, int x) {
     }
 }
 
-/* helper function to set a correct value at the (y, x) coordinates in the pawns array */
+/**
+ * Helper function to set a correct value at the (y,x) coordinates in the pawns array
+ * @param y      [description]
+ * @param x      [description]
+ * @param type   [description]
+ * @param pawn_array [description]
+ */
 void set_pawn(int y, int x, unsigned int type, unsigned int pawn_array[board_size][board_size]) {
 
     if (type > 0 && type < 3 && \
@@ -104,7 +127,10 @@ void zero_pawns(unsigned int pawn_array[board_size][board_size]) {
     }
 }
 
-/* set the pawns in the start position */
+/**
+ * Set the pawns in the start position
+ * @param pawn_array array of played pawns
+ */
 void init_pawns(unsigned int pawn_array[board_size][board_size]) {
 
     /* the 2D array zeroing is not necessary if it is properly initialized to zero */
@@ -180,7 +206,7 @@ unsigned int eval_winner(unsigned int nb_white, unsigned int nb_black) {
     }
 }
 
-static unsigned int count_pawn_to_reverse_one_direction(int y, int x, int direction, unsigned int current_player, unsigned int pawn_array[board_size][board_size]) {
+static unsigned int count_pawn_to_reverse_one_direction(int y, int x, unsigned int direction, unsigned int current_player, unsigned int pawn_array[board_size][board_size]) {
     unsigned int nb_pawns_reversed = 0;
     int moving_y = y, moving_x = x;
 
@@ -200,7 +226,7 @@ static unsigned int count_pawn_to_reverse_one_direction(int y, int x, int direct
 }
 
 /* revert the pawns if needed in one direction */
-static unsigned int reverse_one_direction(int y, int x, int direction, unsigned int current_player, unsigned int pawn_array[board_size][board_size], bool dry_run) {
+static unsigned int reverse_one_direction(int y, int x, unsigned int direction, unsigned int current_player, unsigned int pawn_array[board_size][board_size], bool dry_run) {
     unsigned int nb_pawns_reversed = 0;
     int moving_y = y, moving_x = x;
 
@@ -277,7 +303,6 @@ void free_shots_list(struct shots_list_s* shots_list) {
         list_del(&(list_counter->list));
         free(list_counter);
     }
-
 }
 
 void build_playable_shots_list(unsigned int current_player, struct shots_list_s* shots_list, unsigned int pawn_array[board_size][board_size]) {