summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMario Kilies <MarioKilies@GMX.net>2011-01-13 20:50:42 +0100
committerMario Kilies <MarioKilies@GMX.net>2011-01-13 20:50:42 +0100
commit01cb12bdc0ce66abe47552247d5a2d82c4a12d31 (patch)
tree6428a3393d3a97268c412dc5135f0cfe80d4d7b8 /src
parent6ef4011ecfdf58726c76a60e858dc8e53d1ba5a8 (diff)
Added documentation.
Diffstat (limited to 'src')
-rw-r--r--src/display.c4
1 files changed, 3 insertions, 1 deletions
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)