1 files changed, 115 insertions, 9 deletions

diff --git a/gtk_win.h b/gtk_win.h
index 24cc6cf4455d..590ab0699ea4 100644
--- a/gtk_win.h
+++ b/gtk_win.h
@@ -17,46 +17,143 @@ typedef struct app_data {
 } App_Data;
 
 /**
- * Opens GTK+ Window and prints portfolio data to it. Currently cannot handle encrypted portfolios.
+ * Initializes gtk, loads glade file, connects signals, shows the check window, and enters the
+ * main gtk loop.
  */
 void window_main(void);
 
+/**
+ * Precondition: app.portfolio_string is a String containing a JSON array of portfolio data
+ *
+ * If the JSON array is length 0, the function will do nothing.
+ *
+ * Otherwise, app.portfolio_data will be created from app.portfolio_string and the check list store
+ * will be cleared and appended with this data.
+ */
 void check_list_create_from_string(void);
 
+/**
+ * Precondition: check_list_create_from_string has already been called and api data has been
+ * stored in app.portfolio_data
+ *
+ * Api data from app.portfolio_data will be stored in the check list store
+ */
 void check_list_add_api_data(void);
 
-/** SIGNALS **/
+/********************* SIGNALS *********************/
 
+/**
+ * SIGNAL FOR LOAD BUTTON CLICK
+ *
+ * Loads the portfolio file, decrypts if necessary, collects api data, and adds all the data to
+ * the check list store.
+ * @param button UNUSED -- MAY BE NULL
+ */
 void on_load_button_clicked(GtkButton* button);
 
+/**
+ * SIGNAL FOR LOAD BUTTON CLICK
+ *
+ * Shows either the encrypt or decrypt dialog depending on the button's label.
+ * @param button a GtkButton with either label "Encrypt" or "Decrypt"
+ */
 void on_lock_button_clicked(GtkButton* button);
 
+/**
+ * SIGNAL FOR SET PASSWORD DIALOG RESPONSE
+ *
+ * If response is GTK_RESPONSE_CANCEL (if click cancel or press escape), hide the dialog.
+ * Otherwise, calls on_set_password_entry_activate.
+ * @param dialog
+ * @param response_id response of button activated  -- either GTK_RESPONSE_CANCEL or GTK_RESPONSE_OK
+ */
 void on_set_password_dialog_response(GtkDialog* dialog, gint response_id);
 
+/**
+ * SIGNAL FOR SET PASSWORD ENTRY ACTIVATE
+ *
+ * Activated by keypress ENTER.
+ *
+ * If the length of the entered password is not between 6 and 30 characters or the two entered
+ * passwords are not the same, the password will not be set.
+ * @param entry UNUSED -- MAY BE NULL
+ */
 void on_set_password_entry_activate(GtkEntry* entry);
 
+/**
+ * SIGNAL FOR DECRYPT DIALOG RESPONSE
+ *
+ * If response is GTK_RESPONSE_CANCEL (if click cancel or press escape), hide the dialog.
+ * Otherwise, calls on_decrypt_password_entry_activate.
+ * @param dialog
+ * @param response_id response of button activated  -- either GTK_RESPONSE_CANCEL or GTK_RESPONSE_OK
+ */
 void on_decrypt_dialog_response(GtkDialog* dialog, gint response_id);
 
+/**
+ * SIGNAL FOR DECRYPT PASSWORD ENTRY ACTIVATE
+ *
+ * If the entered password matches app.password, app.password will be cleared.
+ * @param entry UNUSED -- MAY BE NULL
+ */
 void on_decrypt_password_entry_activate(GtkEntry* entry);
 
+/**
+ * SIGNAL FOR ADD, REMOVE, AND SET BUTTON CLICK
+ *
+ * Opens portfolio_modify_dialog based on which button was clicked.
+ * @param button the button clicked
+ */
 void on_modify_button_clicked(GtkButton* button);
 
-void on_modify_entry_activate(GtkEntry* entry, gpointer dialog);
+/**
+ * SIGNAL FOR MODIFY ENTRY ACTIVATE
+ *
+ * Modifies app.portfolio_string according to the values entered in portfolio_modify_dialog
+ * @param entry UNUSED -- MAY BE NULL
+ */
+void on_modify_entry_activate(GtkEntry* entry);
 
+/**
+ * SIGNAL FOR PORTFOLIO MODIFY DIALOG RESPONSE
+ *
+ * If response is GTK_RESPONSE_CANCEL (if click cancel or press escape), hide the dialog.
+ * Otherwise, calls on_modify_entry_activate.
+ * @param dialog
+ * @param response_id response of button activated  -- either GTK_RESPONSE_CANCEL or GTK_RESPONSE_OK
+ */
 void on_portfolio_modify_dialog_response(GtkDialog* dialog, gint response_id);
 
-void on_password_entry_activate(GtkEntry* entry, gpointer dialog);
+/**
+ * SIGNAL FOR PASSWORD ENTRY ACTIVATE
+ *
+ * If the entered password is correct, copy the password to app.password and load the portfolio
+ * @param entry UNUSED -- MAY BE NULL
+ */
+void on_password_entry_activate(GtkEntry* entry);
 
-void on_get_password_dialog_response(GtkDialog* dialog, gint response_id, gpointer entry);
+/**
+ * SIGNAL FOR GET PASSWORD DIALOG RESPONSE
+ *
+ * If response is GTK_RESPONSE_CANCEL (if click cancel or press escape), hide the dialog.
+ * Otherwise, calls on_password_entry_activate.
+ * @param dialog
+ * @param response_id response of button activated  -- either GTK_RESPONSE_CANCEL or GTK_RESPONSE_OK
+ */
+void on_get_password_dialog_response(GtkDialog* dialog, gint response_id);
 
 /**
- * Signal handler for destroying main window. Exits the program.
+ * SIGNAL FOR CHECK WINDOW DESTROY
+ *
+ * Encrypts and writes the portfolio to file if necessary. Unrefs gtk builder and exits main gtk
+ * loop. Destroys all memory in app.
  */
 void on_check_window_destroy(void);
 
 /**
- * Signal handler for clicking column labels. Sorts the ListStore struct according to which
- * column was clicked.
+ * SIGNAL FOR COLUMN CLICKED
+ *
+ * Sorts the ListStore struct according to which column was clicked.
  * @param column clicked column
  * @param list_store portfolio data list
  */
@@ -66,7 +163,7 @@ void on_column_clicked(GtkTreeViewColumn* column, GtkListStore* list_store);
 
 /**
  * Formats text in Info structs for printing to window
- * @param portfolio_data
+ * @param portfolio_data Info_Array* with valid Info data in it.
  */
 void format_cells(Info_Array* portfolio_data);
 
@@ -77,8 +174,17 @@ void format_cells(Info_Array* portfolio_data);
  */
 void list_store_sort(GtkListStore* list_store, Col_Index idx);
 
+/**
+ * Destroys app.portfolio_data and recreates it from app.portfolio_string with api data. Then
+ * recreates the check list.
+ */
 void list_store_update(void);
 
+/**
+ * Shows a generic message dialog.
+ * @param message the message to show
+ * @param success if true, will show a success dialog. otherwise it will show an error dialog.
+ */
 void show_generic_message_dialog(const char* message, gboolean success);
 
 #endif
\ No newline at end of file