Add JSDocs to evaluate board

byanofsky · Jul 4, 2017 · 2b310b0 · 2b310b0
1 parent efb8afe
commit 2b310b0
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/public/js/movecalc.js b/public/js/movecalc.js
@@ -5,7 +5,11 @@ var randomMove = function() {
   return possibleMoves[randomIndex];
 };
 
-// Evaluates current chess board relative to player color ('w' or 'b')
+/**
+ * Evaluates current chess board relative to player
+ * @param {string} color - Players color, either 'b' or 'w'
+ * @return {Number} board value relative to player
+ */
 var evaluateBoard = function(board, color) {
   // Sets the value for each piece using standard piece value
   var pieceValue = {