Start functions documentation.

[Project_algorithmic_C.git] / lib / othello.c

diff --git a/lib/othello.c b/lib/othello.c
index 14c1a9b8c883305a943fbf0f7ee3048f09c0c7d7..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];