RVW: Readability update as requested, new macros

leafyrabbet · leafyrabbet · commit aeb87b32a10f · 2020-05-18T22:09:33.000-04:00
diff --git a/calculator_simple/src/app_window.cpp b/calculator_simple/src/app_window.cpp
@@ -12,6 +12,9 @@
 
 #include <iostream>
 
+#define PROPAGATE_SIG true
+#define DO_NOT_PROPAGATE_SIG false
+
 
 /**
  * @brief   AppWindow Constructor.
@@ -183,15 +186,15 @@ void AppWindow::handle_display_update()
  * @param[in] scroll_type  The type of "scrolling" event that triggered this callback.
  * @param[in] radix_new    The new value after the "scrolling" event, which will be the new radix value.
  * 
- * @returns    
+ * @returns    (boolean) Whether this signal should propagate further to other handlers after this.
  */
 bool AppWindow::handle_radix_change(
         Gtk::ScrollType const & scroll_type
       , double const & radix_new
 )
 {
    short int count = 0;
-   
+
    for (auto const & btn_ptr : btn_arr)
    {
       btn_ptr->set_sensitive(
@@ -200,7 +203,7 @@ bool AppWindow::handle_radix_change(
       count += 1;
    }
 
-   return (false);
+   return (DO_NOT_PROPAGATE_SIG);
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@`
`12`	`12`
`13`	`13`	`#include <iostream>`
`14`	`14`
	`15`	`+#define PROPAGATE_SIG true`
	`16`	`+#define DO_NOT_PROPAGATE_SIG false`
	`17`	`+`
`15`	`18`
`16`	`19`	`/**`
`17`	`20`	`* @brief AppWindow Constructor.`
`@@ -183,15 +186,15 @@ void AppWindow::handle_display_update()`
`183`	`186`	`* @param[in] scroll_type The type of "scrolling" event that triggered this callback.`
`184`	`187`	`* @param[in] radix_new The new value after the "scrolling" event, which will be the new radix value.`
`185`	`188`	`*`
`186`		`- * @returns`
	`189`	`+ * @returns (boolean) Whether this signal should propagate further to other handlers after this.`
`187`	`190`	`*/`
`188`	`191`	`bool AppWindow::handle_radix_change(`
`189`	`192`	`Gtk::ScrollType const & scroll_type`
`190`	`193`	`, double const & radix_new`
`191`	`194`	`)`
`192`	`195`	`{`
`193`	`196`	`short int count = 0;`
`194`		`-`
	`197`	`+`
`195`	`198`	`for (auto const & btn_ptr : btn_arr)`
`196`	`199`	`{`
`197`	`200`	`btn_ptr->set_sensitive(`
`@@ -200,7 +203,7 @@ bool AppWindow::handle_radix_change(`
`200`	`203`	`count += 1;`
`201`	`204`	`}`
`202`	`205`
`203`		`- return (false);`
	`206`	`+ return (DO_NOT_PROPAGATE_SIG);`
`204`	`207`	`}`
`205`	`208`
`206`	`209`