From 58811b0ebd06fd794fdc56a0fa3439246c1142fe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Lino?= <jl@joaolino.com>
Date: Tue, 26 Jul 2022 16:44:00 +0200
Subject: [PATCH] fill missing IScoreboard javadoc

---
 src/main/java/org/example/scoreboard/api/IScoreboard.java | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/example/scoreboard/api/IScoreboard.java b/src/main/java/org/example/scoreboard/api/IScoreboard.java
index 1abe657..b92e9ef 100644
--- a/src/main/java/org/example/scoreboard/api/IScoreboard.java
+++ b/src/main/java/org/example/scoreboard/api/IScoreboard.java
@@ -29,9 +29,9 @@ public interface IScoreboard {
    * Update team scores.
    * Receiving the pair score; home team score and away team score updates a game score.
    *
-   * @param match
-   * @param homeTeamScore
-   * @param awayTeamScore
+   * @param match match to update
+   * @param homeTeamScore home team score
+   * @param awayTeamScore away team score
    * @return updated match
    */
   IMatch updateScore(IMatch match, IScore homeTeamScore, IScore awayTeamScore);
@@ -40,7 +40,7 @@ public interface IScoreboard {
    * Get a summary of games by total score.
    * Those games with the same total score will be returned ordered by the most recently added to our system.
    *
-   * @return
+   * @return ordered game summary
    */
   ArrayList<IMatch> getGameSummary();
 
-- 
2.24.1