From cbd4784d1465d66b7159d9b49d101ce399b9c787 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Thu, 30 Jan 2020 20:02:27 +0100
Subject: [PATCH] Improve the CheckBox and CheckButton class documentations

This makes the CheckBox and CheckButton classes 100% documented.

(cherry picked from commit c9946bc87e269a2733fa28885ed305b381a5f909)
---
 doc/classes/CheckBox.xml    | 23 ++++++++++++++++++++---
 doc/classes/CheckButton.xml | 23 ++++++++++++++++++++---
 2 files changed, 40 insertions(+), 6 deletions(-)

diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml
index 5ba159880e5..b5c7332bc14 100644
--- a/doc/classes/CheckBox.xml
+++ b/doc/classes/CheckBox.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="CheckBox" inherits="Button" version="3.2">
 	<brief_description>
-		Binary choice user interface widget.
+		Binary choice user interface widget. See also [CheckButton].
 	</brief_description>
 	<description>
-		A checkbox allows the user to make a binary choice (choosing only one of two possible options).
+		A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to [CheckButton] in functionality, but it has a different apperance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -18,41 +18,58 @@
 	</constants>
 	<theme_items>
 		<theme_item name="check_vadjust" type="int" default="0">
-			The vertical offset used when rendering the check icons.
+			The vertical offset used when rendering the check icons (in pixels).
 		</theme_item>
 		<theme_item name="checked" type="Texture">
+			The check icon to display when the [CheckBox] is checked.
 		</theme_item>
 		<theme_item name="disabled" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckBox] is disabled.
 		</theme_item>
 		<theme_item name="focus" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckBox] is focused.
 		</theme_item>
 		<theme_item name="font" type="Font">
+			The [Font] to use for the [CheckBox] text.
 		</theme_item>
 		<theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
+			The [CheckBox] text's font color.
 		</theme_item>
 		<theme_item name="font_color_disabled" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )">
+			The [CheckBox] text's font color when it's disabled.
 		</theme_item>
 		<theme_item name="font_color_hover" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
+			The [CheckBox] text's font color when it's hovered.
 		</theme_item>
 		<theme_item name="font_color_hover_pressed" type="Color" default="Color( 1, 1, 1, 1 )">
+			The [CheckBox] text's font color when it's hovered and pressed.
 		</theme_item>
 		<theme_item name="font_color_pressed" type="Color" default="Color( 1, 1, 1, 1 )">
+			The [CheckBox] text's font color when it's pressed.
 		</theme_item>
 		<theme_item name="hover" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckBox] is hovered.
 		</theme_item>
 		<theme_item name="hover_pressed" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckBox] is hovered and pressed.
 		</theme_item>
 		<theme_item name="hseparation" type="int" default="4">
+			The separation between the check icon and the text (in pixels).
 		</theme_item>
 		<theme_item name="normal" type="StyleBox">
+			The [StyleBox] to display as a background.
 		</theme_item>
 		<theme_item name="pressed" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckBox] is pressed.
 		</theme_item>
 		<theme_item name="radio_checked" type="Texture">
+			If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
 		</theme_item>
 		<theme_item name="radio_unchecked" type="Texture">
+			If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
 		</theme_item>
 		<theme_item name="unchecked" type="Texture">
+			The check icon to display when the [CheckBox] is unchecked.
 		</theme_item>
 	</theme_items>
 </class>
diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml
index e6a890b21fe..769acb5d16a 100644
--- a/doc/classes/CheckButton.xml
+++ b/doc/classes/CheckButton.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="CheckButton" inherits="Button" version="3.2">
 	<brief_description>
-		Checkable button.
+		Checkable button. See also [CheckBox].
 	</brief_description>
 	<description>
-		CheckButton is a toggle button displayed as a check field.
+		CheckButton is a toggle button displayed as a check field. It's similar to [CheckBox] in functionality, but it has a different apperance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an [b]immediate[/b] effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -18,41 +18,58 @@
 	</constants>
 	<theme_items>
 		<theme_item name="check_vadjust" type="int" default="0">
-			The vertical offset used when rendering the icons.
+			The vertical offset used when rendering the toggle icons (in pixels).
 		</theme_item>
 		<theme_item name="disabled" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckButton] is disabled.
 		</theme_item>
 		<theme_item name="focus" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckButton] is focused.
 		</theme_item>
 		<theme_item name="font" type="Font">
+			The [Font] to use for the [CheckButton] text.
 		</theme_item>
 		<theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
+			The [CheckButton] text's font color.
 		</theme_item>
 		<theme_item name="font_color_disabled" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )">
+			The [CheckButton] text's font color when it's disabled.
 		</theme_item>
 		<theme_item name="font_color_hover" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
+			The [CheckButton] text's font color when it's hovered.
 		</theme_item>
 		<theme_item name="font_color_hover_pressed" type="Color" default="Color( 1, 1, 1, 1 )">
+			The [CheckButton] text's font color when it's hovered and pressed.
 		</theme_item>
 		<theme_item name="font_color_pressed" type="Color" default="Color( 1, 1, 1, 1 )">
+			The [CheckButton] text's font color when it's pressed.
 		</theme_item>
 		<theme_item name="hover" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckButton] is hovered.
 		</theme_item>
 		<theme_item name="hover_pressed" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckButton] is hovered and pressed.
 		</theme_item>
 		<theme_item name="hseparation" type="int" default="4">
+			The separation between the toggle icon and the text (in pixels).
 		</theme_item>
 		<theme_item name="normal" type="StyleBox">
+			The [StyleBox] to display as a background.
 		</theme_item>
 		<theme_item name="off" type="Texture">
+			The icon to display when the [CheckButton] is unchecked.
 		</theme_item>
 		<theme_item name="off_disabled" type="Texture">
+			The icon to display when the [CheckButton] is unchecked and disabled.
 		</theme_item>
 		<theme_item name="on" type="Texture">
+			The icon to display when the [CheckButton] is checked.
 		</theme_item>
 		<theme_item name="on_disabled" type="Texture">
+			The icon to display when the [CheckButton] is checked and disabled.
 		</theme_item>
 		<theme_item name="pressed" type="StyleBox">
+			The [StyleBox] to display as a background when the [CheckButton] is pressed.
 		</theme_item>
 	</theme_items>
 </class>