From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Sat, 2 Sep 2017 18:36:17 +0000 (+0200)
Subject: More functions commented.
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=5ec791f6f2aef3f10c615eb4a336fc6282ebb8d9;p=Project_algorithmic_C.git

More functions commented.
---

diff --git a/lib/othello.c b/lib/othello.c
index 4f65659..cbc7e4f 100644
--- a/lib/othello.c
+++ b/lib/othello.c
@@ -60,7 +60,7 @@ unsigned int current_opponent(unsigned int current_player) {
  * The origin O has (1, 1) coordinates */
 
 /**
- * Get pawn value at coordinates (x,y)
+ * Get pawn value at coordinates (y,x)
  * @param  y          y coordinate
  * @param  x          x coordinate
  * @param  pawn_array array of played pawns
@@ -93,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 [name] [description]
+ */
 void set_pawn(int y, int x, unsigned int type, unsigned int pawn_array[board_size][board_size]) {
 
     if (type > 0 && type < 3 && \
@@ -121,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 */