From c6cea6e9b372f403a5906813bf5db8583d747d06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 12:38:01 +0200 Subject: doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. --- doc/classes/Range.xml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'doc/classes/Range.xml') diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 9f1863600b..ba3e0fa3b2 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -27,34 +27,34 @@ - + If [code]true[/code], [member value] may be greater than [member max_value]. Default value: [code]false[/code]. - + If [code]true[/code], [member value] may be less than [member min_value]. Default value: [code]false[/code]. - + If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. - + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. - + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. - + Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. - + The value mapped between 0 and 1. - + If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. - + If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. - + Range's current value. -- cgit v1.2.3 From b9aa13e5917b45a540e92e50b81f7bc923e493d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 15:24:23 +0200 Subject: doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. --- doc/classes/Range.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/classes/Range.xml') diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index ba3e0fa3b2..e3f449eed4 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -28,19 +28,19 @@ - If [code]true[/code], [member value] may be greater than [member max_value]. Default value: [code]false[/code]. + If [code]true[/code], [member value] may be greater than [member max_value]. - If [code]true[/code], [member value] may be less than [member min_value]. Default value: [code]false[/code]. + If [code]true[/code], [member value] may be less than [member min_value]. If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. - Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. - Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. @@ -49,7 +49,7 @@ The value mapped between 0 and 1. - If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. + If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. -- cgit v1.2.3 From a78373ddc2c1123b13161da2037a16c40a3c4b26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 21:22:15 +0200 Subject: doc: Remove null default values that can't be determined Applying #30187. --- doc/classes/Range.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/classes/Range.xml') diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index e3f449eed4..82fffd0cb8 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -45,7 +45,7 @@ Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. - + The value mapped between 0 and 1. -- cgit v1.2.3