From c8cbc34ba9da7fb2c5ac1c6da83520fef37d9252 Mon Sep 17 00:00:00 2001
From: OpenAI Codex <codex@openai.com>
Date: Wed, 8 Apr 2026 19:58:13 +0200
Subject: [PATCH] Review usermenu.h comments

Apply the reviewed usermenu.h comment wording from the branch-target
sequential review run.

What changed:
- clarified that the background icon reader stop flag means icon reading has
  stopped because the main window has already closed or is closing
- replaced popup wording with submenu wording for the submenu begin and end
  enum markers
- tightened several helper comments around icon retrieval and hotkey parsing
  to read more directly while preserving the documented behavior

Why it changed:
- the approved review output improves readability and consistency of the user
  menu comments without changing code behavior
- the updated wording better matches the actual menu concepts used by the
  surrounding declarations

How the result was verified:
- completed the full branch-target sequential review pipeline through HTML
- confirmed comment guard passes with zero violations in strict and
  ignore-whitespace modes
- checked the resulting git diff and git diff --check for src/usermenu.h
  before committing
---
 src/usermenu.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/usermenu.h b/src/usermenu.h
index 8e28e6169..0fb336132 100644
--- a/src/usermenu.h
+++ b/src/usermenu.h
@@ -48,7 +48,7 @@ class CUserMenuIconBkgndReader
     DWORD IconReaderThreadUID; // generator of unique thread IDs for reading icons
     BOOL CurIRThreadIDIsValid; // TRUE = the thread is running and CurIRThreadID is valid
     DWORD CurIRThreadID;       // unique thread ID (see IconReaderThreadUID) that loads icons for the current user menu version
-    BOOL AlreadyStopped;       // TRUE = no more icon reading, the main window has closed/is closing
+    BOOL AlreadyStopped;       // TRUE = no more icon reading; the main window has closed/is closing
 
     int UserMenuIconsInUse;                            // > 0: user menu icons are currently in an open menu, so we cannot update them immediately; at most 2 (Salamander cfg + Find: user menu)
     CUserMenuIconDataArr* UserMenuIIU_BkgndReaderData; // storage for new icons when UserMenuIconsInUse > 0
@@ -99,8 +99,8 @@ extern CUserMenuIconBkgndReader UserMenuIconBkgndReader;
 enum CUserMenuItemType
 {
     umitItem,         // standard item
-    umitSubmenuBegin, // marks the start of a popup
-    umitSubmenuEnd,   // marks the end of a popup
+    umitSubmenuBegin, // marks the start of a submenu
+    umitSubmenuEnd,   // marks the end of a submenu
     umitSeparator     // marks the end of a popup
 };
 
@@ -134,14 +134,14 @@ struct CUserMenuItem
     // Tries to retrieve the icon handle in this order
     // a) the Icon variable
     // b) SHGetFileInfo
-    // c) take the system default
+    // c) takes the system default
     // Reading icons in the background: if 'bkgndReaderData' is NULL, we read immediately; otherwise the icons
     // are read in the background. If 'getIconsFromReader' is FALSE, we collect what to load into 'bkgndReaderData'.
     // If it is TRUE, the icons are already loaded and we simply take over the handles of the loaded icons
-    // stored in 'bkgndReaderData'.
+    // from 'bkgndReaderData'.
     BOOL GetIconHandle(CUserMenuIconDataArr* bkgndReaderData, BOOL getIconsFromReader);
 
-    // Searches ItemName for '&' and returns the hotkey; returns TRUE if one is found.
+    // Searches ItemName for '&' and returns HotKey; returns TRUE if one is found.
     BOOL GetHotKey(char* key);
 
     BOOL Set(char* name, char* umCommand, char* arguments, char* initDir, char* icon);