Add more high-level comments

include/ezgl/application.hpp

@@ -260,18 +260,6 @@ class application {
    */
   void quit();
 
-  /**
-   * Set the disable_event_loop flag to new_setting
-   * Call with new_setting == true to make the event_loop immediately return.
-   * Needed only for auto-marking
-   *
-   * @param new_setting The new state of disable_event_loop flag
-   */
-  static void set_disable_event_loop(bool new_setting)
-  {
-    disable_event_loop = new_setting;
-  }
-
 private:
   // The package path to the XML file that describes the UI.
   std::string m_main_ui;
@@ -322,10 +310,16 @@ class application {
 
   // The user-defined callback function for handling keyboard press
   key_callback_fn key_press_callback;
-
-  // A flag to disable event loop (default is false)
-  static bool disable_event_loop;
 };
 }
 
+/**
+ * Set the disable_event_loop flag to new_setting
+ * Call with new_setting == true to make the event_loop immediately return.
+ * Needed only for auto-marking
+ *
+ * @param new_setting The new state of disable_event_loop flag
+ */
+void set_disable_event_loop(bool new_setting);
+
 #endif //EZGL_APPLICATION_HPP

include/ezgl/callback.hpp

@@ -11,6 +11,8 @@
 
 namespace ezgl {
 
+/**** Callback functions for keyboard and mouse input, and for all the ezgl predefined buttons. *****/
+
 /**
  * React to a <a href = "https://developer.gnome.org/gtk3/stable/GtkWidget.html#GtkWidget-key-press-event">keyboard
  * press event</a>.

include/ezgl/camera.hpp

@@ -8,6 +8,7 @@ namespace ezgl {
 
 /**
  * Manages the transformations between coordinate systems.
+ * Application code doesn't (and can't) call these functions; they are for ezgl internal use.
  *
  * The camera class manages transformations between a GTK widget, world, and "screen" coordinate system. A GTK widget
  * has dimensions that change based on the user, and its aspect ratio may not match the world coordinate system. The

include/ezgl/canvas.hpp

@@ -12,6 +12,8 @@
 
 namespace ezgl {
 
+/**** Functions in this class are for ezgl internal use; application code doesn't need to call them ****/
+
 class renderer;
 
 /**

include/ezgl/control.hpp

@@ -6,6 +6,9 @@
 
 namespace ezgl {
 
+/**** Functions to manipulate what is visible on the screen; used by ezgl's predefined buttons. ****/
+/**** Application code does not have to ever call these functions.                              ****/
+
 class canvas;
 
 /**

include/ezgl/graphics.hpp

@@ -156,6 +156,8 @@ class renderer {
    */
   rectangle get_visible_world();
 
+  /**** Functions to set graphics attributes (for all subsequent drawing calls). ****/
+
   /**
    * Change the color for subsequent draw calls.
    *
@@ -246,6 +248,8 @@ class renderer {
    */
   void set_vert_text_just(text_just vert_just);
 
+  /**** Functions to draw various graphics primitives ****/
+
   /**
    * Draw a line.
    *

src/application.cpp

@@ -1,9 +1,9 @@
 #include "ezgl/application.hpp"
 
-namespace ezgl {
-
 // A flag to disable event loop (default is false)
-bool application::disable_event_loop = false;
+bool disable_event_loop = false;
+
+namespace ezgl {
 
 void application::startup(GtkApplication *, gpointer user_data)
 {
@@ -358,3 +358,8 @@ void application::refresh_drawing()
   cnv->redraw();
 }
 }
+
+void set_disable_event_loop(bool new_setting)
+{
+  disable_event_loop = new_setting;
+}