EmuWindow: Better document the purpose of OnMinimalClientAreaChangeRequest.

1 files changed, 7 insertions, 0 deletions

diff --git a/src/common/emu_window.h b/src/common/emu_window.h
index 3817a7734..a9cf71690 100644
--- a/src/common/emu_window.h
+++ b/src/common/emu_window.h
@@ -100,6 +100,8 @@ protected:
 
     /**
      * Processes any pending configuration changes from the last SetConfig call.
+     * This method invokes OnMinimalClientAreaChangeRequest if the corresponding configuration
+     * field changed.
      * @note Implementations will usually want to call this from the GUI thread.
      */
     void ProcessConfigurationChanges() {
@@ -130,7 +132,12 @@ protected:
     }
 
 private:
+    /**
+     * Handler called when the minimal client area was requested to be changed via SetConfig.
+     * For the request to be honored, EmuWindow implementations will usually reimplement this function.
+     */
     virtual void OnMinimalClientAreaChangeRequest(const std::pair<unsigned,unsigned>& minimal_size) {
+        // By default, ignore this request and do nothing.
     }
 
     std::pair<unsigned,unsigned> framebuffer_size;