From 01cb12bdc0ce66abe47552247d5a2d82c4a12d31 Mon Sep 17 00:00:00 2001 From: Mario Kilies Date: Thu, 13 Jan 2011 20:50:42 +0100 Subject: Added documentation. --- src/display.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/display.c') diff --git a/src/display.c b/src/display.c index 04afd05..da12eae 100644 --- a/src/display.c +++ b/src/display.c @@ -134,7 +134,9 @@ void display_window_stack_points(const tablestacks ts) } /** - * Displays the current state window. + * Displays the current state window, showing all player names and their open cards and the client player's score. + * @param[in] pnoc Array of (player name, open card) tuples. Array has to be sorted by open card, lowest open card first + * @param[in] num_players The number of players to show a player name and open card for * @param[in] score The players score */ void display_window_current_state(const player_name_open_card_tuple pnoc[], const uint8_t num_players, const uint32_t score) -- cgit v1.2.3