]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/models/range/range-docs.factor
core, basis, extra: Remove DOS line endings from files.
[factor.git] / basis / models / range / range-docs.factor
index 7e205157f29447e6e36cef27f6b547d6588b7ffe..dc3cc35e872a65c296bb0809711d1572e55dfe47 100644 (file)
@@ -1,66 +1,66 @@
-USING: help.syntax help.markup kernel math classes classes.tuple\r
-calendar models ;\r
-IN: models.range\r
-\r
-HELP: range\r
-{ $class-description "Range models implement the " { $link "range-model-protocol" } " with real numbers as the minimum, current, maximum, and page size. Range models are created with " { $link <range> } "." }\r
-{ $notes { $link "ui.gadgets.sliders" } " use range models." } ;\r
-\r
-HELP: <range>\r
-{ $values { "value" real } { "page" real } { "min" real } { "max" real } { "step" real } { "range" range } }\r
-{ $description "Creates a new " { $link range } " model." } ;\r
-\r
-HELP: range-model\r
-{ $values { "range" range } { "model" model } }\r
-{ $description "Outputs a model holding a range model's current value." }\r
-{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
-\r
-HELP: range-min\r
-{ $values { "range" range } { "model" model } }\r
-{ $description "Outputs a model holding a range model's minimum value." }\r
-{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
-\r
-HELP: range-max\r
-{ $values { "range" range } { "model" model } }\r
-{ $description "Outputs a model holding a range model's maximum value." }\r
-{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
-\r
-HELP: range-page\r
-{ $values { "range" range } { "model" model } }\r
-{ $description "Outputs a model holding a range model's page size." }\r
-{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
-\r
-HELP: move-by\r
-{ $values { "amount" real } { "range" range } }\r
-{ $description "Adds a number to a range model's current value." }\r
-{ $side-effects "range" } ;\r
-\r
-HELP: move-by-page\r
-{ $values { "amount" real } { "range" range } }\r
-{ $description "Adds a multiple of the page size to a range model's current value." }\r
-{ $side-effects "range" } ;\r
-\r
-ARTICLE: "models-range" "Range models"\r
-"Range models ensure their value is a real number within a fixed range."\r
-{ $subsections\r
-    range\r
-    <range>\r
-}\r
-"Range models conform to a protocol for getting and setting the current value, as well as the endpoints of the range."\r
-{ $subsections "range-model-protocol" } ;\r
-\r
-ARTICLE: "range-model-protocol" "Range model protocol"\r
-"The range model protocol is implemented by the " { $link range } " and " { $link compose } " classes. User-defined models may implement it too."\r
-{ $subsections\r
-    range-value\r
-    range-page-value\r
-    range-min-value\r
-    range-max-value\r
-    range-max-value*\r
-    set-range-value\r
-    set-range-page-value\r
-    set-range-min-value \r
-    set-range-max-value \r
-} ;\r
-\r
-ABOUT: "models-range"\r
+USING: help.syntax help.markup kernel math classes classes.tuple
+calendar models ;
+IN: models.range
+
+HELP: range
+{ $class-description "Range models implement the " { $link "range-model-protocol" } " with real numbers as the minimum, current, maximum, and page size. Range models are created with " { $link <range> } "." }
+{ $notes { $link "ui.gadgets.sliders" } " use range models." } ;
+
+HELP: <range>
+{ $values { "value" real } { "page" real } { "min" real } { "max" real } { "step" real } { "range" range } }
+{ $description "Creates a new " { $link range } " model." } ;
+
+HELP: range-model
+{ $values { "range" range } { "model" model } }
+{ $description "Outputs a model holding a range model's current value." }
+{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;
+
+HELP: range-min
+{ $values { "range" range } { "model" model } }
+{ $description "Outputs a model holding a range model's minimum value." }
+{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;
+
+HELP: range-max
+{ $values { "range" range } { "model" model } }
+{ $description "Outputs a model holding a range model's maximum value." }
+{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;
+
+HELP: range-page
+{ $values { "range" range } { "model" model } }
+{ $description "Outputs a model holding a range model's page size." }
+{ $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;
+
+HELP: move-by
+{ $values { "amount" real } { "range" range } }
+{ $description "Adds a number to a range model's current value." }
+{ $side-effects "range" } ;
+
+HELP: move-by-page
+{ $values { "amount" real } { "range" range } }
+{ $description "Adds a multiple of the page size to a range model's current value." }
+{ $side-effects "range" } ;
+
+ARTICLE: "models-range" "Range models"
+"Range models ensure their value is a real number within a fixed range."
+{ $subsections
+    range
+    <range>
+}
+"Range models conform to a protocol for getting and setting the current value, as well as the endpoints of the range."
+{ $subsections "range-model-protocol" } ;
+
+ARTICLE: "range-model-protocol" "Range model protocol"
+"The range model protocol is implemented by the " { $link range } " and " { $link compose } " classes. User-defined models may implement it too."
+{ $subsections
+    range-value
+    range-page-value
+    range-min-value
+    range-max-value
+    range-max-value*
+    set-range-value
+    set-range-page-value
+    set-range-min-value 
+    set-range-max-value 
+} ;
+
+ABOUT: "models-range"