Updated source code documentation. Included Doxyfile.

1 files changed, 19 insertions, 0 deletions

diff --git a/src/display.c b/src/display.c
index 2ca3a5c..78b40f2 100644
--- a/src/display.c
+++ b/src/display.c
@@ -115,6 +115,12 @@ static void draw_cardstack(WINDOW *w, const uint8_t row, const uint8_t col, cons
 	}
 }
 
+/**
+ * Displays the table cards window. Draws table stacks and can highlight a stack.
+ * @param[in] ts The table stacks to display
+ * @param[in] highlight If true, a stack will be highlighted
+ * @param[in] highlighted_stack The stack to highlight. Only used, if highlight is true
+*/
 void display_window_table_cards(const tablestacks ts, const bool highlight, const uint8_t highlighted_stack)
 {
 	wattron(w_table_cards, A_BOLD);
@@ -138,6 +144,10 @@ void display_window_table_cards(const tablestacks ts, const bool highlight, cons
 	wrefresh(w_table_cards);
 }
 
+/**
+ * Displays the stack points window.
+ * @param[in] ts The table stacks used for calculation of stack points
+*/
 void display_window_stack_points(const tablestacks ts)
 {
 	wattron(w_stack_points, A_BOLD);
@@ -156,6 +166,7 @@ void display_window_stack_points(const tablestacks ts)
  * 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] active_players The currently active player
  * @param[in] score The players score
 */
 void display_window_current_state(const player_name_open_card_tuple pnoc[], const uint8_t num_players, const uint8_t active_player, const uint32_t score)
@@ -194,6 +205,8 @@ void display_window_current_state(const player_name_open_card_tuple pnoc[], cons
 /**
  * Displays the hand cards window.
  * @param[in] h The hand that will be displayed. h must not contain 0
+ * @param[in] highlight If true, a card will be highlighted
+ * @param[in] highlighted_card The card to highlight. Only used, if highlight is true
 */
 void display_window_hand_cards(const hand h, const bool highlight, const uint8_t highlighted_card)
 {
@@ -221,6 +234,9 @@ void display_window_hand_cards(const hand h, const bool highlight, const uint8_t
 	wrefresh(w_hand_cards);
 }
 
+/**
+ * Initializes ncurses.
+*/
 void display_init(void)
 {
 	initscr();	// Start curses mode
@@ -285,6 +301,9 @@ void display_init(void)
 	sleep(4);
 }
 
+/**
+ * Finalizes ncurses.
+*/
 void display_fini(void)
 {
 	delwin(w_table_cards);