From 3eea38ae0593dc5d82b0fd94305fe9603bd41f13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Thu, 16 Nov 2023 16:22:49 +0100 Subject: [PATCH] fix comments --- include/download.h | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/include/download.h b/include/download.h index a95c6cc..ff8bccf 100644 --- a/include/download.h +++ b/include/download.h @@ -17,17 +17,21 @@ namespace Download std::optional open_game_json(char const *filename); /** - * @brief Create game object from given source - * @param game_spec Either an id to download from hanab.live or a filename with a json specification + * @brief Create game object from given source. + * @param game_id Id to download from hanab.live. * @param score_goal What score counts as a win for this game. If left empty, the maximum score is inserted. * @return Game state * - * If both turn and draw_pile_break are specified, the game skips until the specified turn or the first time the - * draw pile hits the given size, whichever comes first - * */ Hanabi::Game get_game(int game_id, std::optional score_goal); + /** + * @brief Create game object from given source. + * @param filename Filename with a json specification of the game in hanab.live format. + * @param score_goal What score counts as a win for this game. If left empty, the maximum score is inserted. + * @return Game state + * + */ Hanabi::Game get_game(std::string const & filename, std::optional score_goal); } // namespace Download