[Scummvm-git-logs] scummvm master -> 9d53e29a3567bb21a4c640bf22cdd6f83046fd43

[antoniou79]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
9d53e29a35 GUI: Clarify usage of groupId, groupLeaderId in comments


Commit: 9d53e29a3567bb21a4c640bf22cdd6f83046fd43
    https://github.com/scummvm/scummvm/commit/9d53e29a3567bb21a4c640bf22cdd6f83046fd43
Author: antoniou79 (a.antoniou79 at gmail.com)
Date: 2024-10-25T21:24:40+03:00

Commit Message:
GUI: Clarify usage of groupId, groupLeaderId in comments

groupLeaderId is a non-zero byte id, arbitrary but unique, for the leader of a checkbox group, or zero otherwise.

All direct children checkboxes set their groupId to match the groupLeaderId of the leader of their checkbox group.

Changed paths:
    engines/metaengine.h


diff --git a/engines/metaengine.h b/engines/metaengine.h
index 48407ddc356..d3c790a1150 100644
--- a/engines/metaengine.h
+++ b/engines/metaengine.h
@@ -72,8 +72,8 @@ struct ExtraGuiOption {
 	const char *tooltip;       /*!< Option tooltip shown when the mouse cursor hovers over it. */
 	const char *configOption;  /*!< confMan key, e.g. "fullscreen". */
 	bool defaultState;         /*!< Default state of the checkbox (checked or not). */
-	byte groupId;        /*!< Id for the checkbox's group, or 0 for no group. */
-	byte groupLeaderId;  /*!< When this checkbox is unchecked, disable all checkboxes in this group. One leader per group. */
+	byte groupId;        /*!< Set to the leader Id (groupLeaderId) for the checkbox's group, or 0 for no group. */
+	byte groupLeaderId;  /*!< Set to a non-zero value only for the leader of the checkbox group. When this leader checkbox is unchecked, disable all checkboxes in this group. One leader per group. */
 };
 
 /**