From 0a0328b126781fae6ecc73de832bb5921ae49765 Mon Sep 17 00:00:00 2001
From: Stephen Anthony <sa666666@gmail.com>
Date: Fri, 23 Oct 2020 21:45:04 -0230
Subject: [PATCH] Minor updates to comments.

---
 src/emucore/FrameBuffer.hxx | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/src/emucore/FrameBuffer.hxx b/src/emucore/FrameBuffer.hxx
index 689a0935d..c084c9cf6 100644
--- a/src/emucore/FrameBuffer.hxx
+++ b/src/emucore/FrameBuffer.hxx
@@ -41,8 +41,8 @@ class TIASurface;
 
 /**
   This class encapsulates all video buffers and is the basis for the video
-  display in Stella.  All graphics ports should derive from this class for
-  platform-specific video stuff.
+  display in Stella.  The FBBackend object contained in this class is
+  platform-specific, and most rendering tasks are delegated to it.
 
   The TIA is drawn here, and all GUI elements (ala ScummVM, which are drawn
   into FBSurfaces), are in turn drawn here as well.
@@ -221,19 +221,17 @@ class FrameBuffer
     /**
       Changes the fullscreen overscan.
 
-      @param direction  +1 indicates increase, -1 indicates decrease.
+      @param direction  +1 indicates increase, -1 indicates decrease
     */
     void changeOverscan(int direction = +1);
 
     /**
-      This method is called when the user wants to switch to the next
+      This method is called when the user wants to switch to the previous/next
       available TIA video mode.  In windowed mode, this typically means going
       to the next/previous zoom level.  In fullscreen mode, this typically
       means switching between normal aspect and fully filling the screen.
-        direction = -1 means go to the next lower video mode
-        direction = +1 means go to the next higher video mode
 
-      @param direction  +1 indicates increase, -1 indicates decrease.
+      @param direction  +1 indicates next mode, -1 indicates previous mode
     */
     void switchVideoMode(int direction = +1);
 
@@ -372,6 +370,11 @@ class FrameBuffer
     */
     void reloadSurfaces();
 
+    /**
+      Frees and reloads all surfaces that the framebuffer knows about.
+    */
+    void resetSurfaces();
+
     /**
       Draw pending messages.
 
@@ -379,13 +382,17 @@ class FrameBuffer
     */
     bool drawMessage();
 
-    // Draws the frame stats overlay
+    /**
+      Draws the frame stats overlay.
+    */
     void drawFrameStats(float framesPerSecond);
 
     /**
       Build an applicable video mode based on the current settings in
       effect, whether TIA mode is active, etc.  Then tell the backend
       to actually use the new mode.
+
+      @return  Whether the operation succeeded or failed
     */
     FBInitStatus applyVideoMode();
 
@@ -400,11 +407,6 @@ class FrameBuffer
     */
     void setFullscreen(bool enable);
 
-    /**
-      Frees and reloads all surfaces that the framebuffer knows about.
-    */
-    void resetSurfaces();
-
   #ifdef GUI_SUPPORT
     /**
       Setup the UI fonts