From 6c121afcaad1ebd7f46aad62fc431991eec0e69c Mon Sep 17 00:00:00 2001
From: Pierre Ossman <ossman@cendio.se>
Date: Thu, 9 Dec 2021 16:53:22 +0100
Subject: [PATCH] Add comments to stored parameters list

Clarify what this list is used for, and organize it so it is easier to
match to the options dialog.
---
 vncviewer/parameters.cxx | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/vncviewer/parameters.cxx b/vncviewer/parameters.cxx
index c6e902ea..1217e8d4 100644
--- a/vncviewer/parameters.cxx
+++ b/vncviewer/parameters.cxx
@@ -169,15 +169,22 @@ StringParameter via("via", "Gateway to tunnel via", "");
 
 static const char* IDENTIFIER_STRING = "TigerVNC Configuration file Version 1.0";
 
+/*
+ * We only save the sub set of parameters that can be modified from
+ * the graphical user interface
+ */
 static VoidParameter* parameterArray[] = {
+  /* Security */
 #ifdef HAVE_GNUTLS
   &CSecurityTLS::X509CA,
   &CSecurityTLS::X509CRL,
 #endif // HAVE_GNUTLS
   &SecurityClient::secTypes,
-  &emulateMiddleButton,
+  /* Misc. */
   &dotWhenNoCursor,
   &reconnectOnError,
+  &shared,
+  /* Compression */
   &autoSelect,
   &fullColour,
   &lowColourLevel,
@@ -186,13 +193,15 @@ static VoidParameter* parameterArray[] = {
   &compressLevel,
   &noJpeg,
   &qualityLevel,
+  /* Screen */
   &fullScreen,
   &fullScreenMode,
   &fullScreenSelectedMonitors,
   &desktopSize,
   &remoteResize,
+  /* Input */
   &viewOnly,
-  &shared,
+  &emulateMiddleButton,
   &acceptClipboard,
   &sendClipboard,
 #if !defined(WIN32) && !defined(__APPLE__)
-- 
2.39.5