Adds comment

5 years ago · 4fd90a3811
parent 02ba62654f
commit 4fd90a3811
1 changed files with 4 additions and 0 deletions
--- a/app/src/main/java/net/pokeranalytics/android/ui/modules/handhistory/evaluator/EvaluatorBridge.kt
+++ b/app/src/main/java/net/pokeranalytics/android/ui/modules/handhistory/evaluator/EvaluatorBridge.kt
@ -28,6 +28,10 @@ class EvaluatorBridge {

 	companion object {

+		/***
+		 * Returns the best possible hand with the given [hand] and [board]
+		 * The result is in the form of an Int where having the lowest score is the best
+		 */
 		fun playerHand(hand: List<Card>, board: List<Card>): Int {

 			val handCards = hand.mapNotNull { it.toEvaluatorCard() }