From 4fd90a38117b28bd69c2fe277f544d05edca51ad Mon Sep 17 00:00:00 2001
From: Laurent <laurent@staxriver.com>
Date: Fri, 23 Apr 2021 12:35:18 +0200
Subject: [PATCH] Adds comment

---
 .../ui/modules/handhistory/evaluator/EvaluatorBridge.kt       | 4 ++++
 1 file changed, 4 insertions(+)

diff --git 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
index ce444b6d..4ec71150 100644
--- 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() }