Added file comments, changed some fn names for readability reasons

Author: SebastianLievano

vpr/src/draw/draw_toggle_functions.cpp

@@ -1,6 +1,14 @@
-/*draw_toggle_functions.cpp contains callback functions that change draw_state variables
- * connected to buttons and sliders on the GUI.
+/**
+ * @file draw_toggle_functions.cpp
+ * @author Sebastian Lievano ([email protected])
+ * @brief Callback functions for ui elements
+ * @date July 4th, 2022
+ * 
+ * This file contains all of the callback functions for UI elements. 
+ * Please add any new callback functions here, and if it makes sense, add _cbk at the end 
+ * of function name to prevent someone else calling it in any non gtk context. 
  */
+
 #include <cstdio>
 #include <cfloat>
 #include <cstring>
@@ -405,7 +413,7 @@ void toggle_expansion_cost_cbk(GtkComboBoxText* self, ezgl::application* app) {
  * @param self self ptr to GtkSpinButton
  * @param app ezgl::app
  */
-void set_net_max_fanout(GtkSpinButton* self, ezgl::application* app) {
+void set_net_max_fanout_cbk(GtkSpinButton* self, ezgl::application* app) {
     t_draw_state* draw_state = get_draw_state_vars();
     draw_state->draw_net_max_fanout = gtk_spin_button_get_value_as_int(self);
     app->refresh_drawing();
@@ -418,7 +426,7 @@ void set_net_max_fanout(GtkSpinButton* self, ezgl::application* app) {
  * @param self 
  * @param app 
  */
-void set_net_alpha_value(GtkSpinButton* self, ezgl::application* app) {
+void set_net_alpha_value_cbk(GtkSpinButton* self, ezgl::application* app) {
     t_draw_state* draw_state = get_draw_state_vars();
     draw_state->net_alpha = gtk_spin_button_get_value_as_int(self);
     app->refresh_drawing();

vpr/src/draw/draw_toggle_functions.h

@@ -1,6 +1,12 @@
 #ifndef DRAW_TOGGLE_FUNCTIONS_H
 #define DRAW_TOGGLE_FUNCTIONS_H
 
+/**
+ * @file draw_toggle_functions.h
+ * @author Sebastian Lievano
+ * @brief Declarations of callback functions.
+ */
+
 #include <cstdio>
 #include <cfloat>
 #include <cstring>
@@ -47,12 +53,12 @@ void toggle_nets_cbk(GtkComboBox* self, ezgl::application* app);
 
 /* Callback function for runtime created netMaxFanout widget in ui_setup.cpp.
  * Sets draw_state->draw_net_max_fanout to its corresponding value in the UI. */
-void set_net_max_fanout(GtkSpinButton* self, ezgl::application* app);
+void set_net_max_fanout_cbk(GtkSpinButton* self, ezgl::application* app);
 
 /* Callback function for runtime created netAlpha widget in ui_setup.cpp.
  * Sets draw_state->net_alpha (a value from 0 to 1 representing transparency) to
  * its corresponding value in the UI. */
-void set_net_alpha_value(GtkSpinButton* self, ezgl::application* app);
+void set_net_alpha_value_cbk(GtkSpinButton* self, ezgl::application* app);
 
 /* Callback function for runtime created toggle_blk_internal button in ui_setup.cpp.
  * With each consecutive click of the button, a lower level in the

vpr/src/draw/ui_setup.cpp

@@ -65,13 +65,13 @@ void net_button_setup(ezgl::application* app) {
 
     //Manages net alpha
     GtkSpinButton* net_alpha = GTK_SPIN_BUTTON(app->get_object("NetAlpha"));
-    g_signal_connect(net_alpha, "value-changed", G_CALLBACK(set_net_alpha_value), app);
+    g_signal_connect(net_alpha, "value-changed", G_CALLBACK(set_net_alpha_value_cbk), app);
     gtk_spin_button_set_increments(net_alpha, 1, 1);
     gtk_spin_button_set_range(net_alpha, 1, 255);
 
     //Manages net max fanout
     GtkSpinButton* max_fanout = GTK_SPIN_BUTTON(app->get_object("NetMaxFanout"));
-    g_signal_connect(max_fanout, "value-changed", G_CALLBACK(set_net_max_fanout), app);
+    g_signal_connect(max_fanout, "value-changed", G_CALLBACK(set_net_max_fanout_cbk), app);
     gtk_spin_button_set_increments(max_fanout, 1, 1);
     gtk_spin_button_set_range(max_fanout, 0., (double)get_max_fanout());
 }