steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

models: cleanup docs for $slots.

master
John Benediktsson 2020-05-27 12:51:31 -07:00
parent 82a34fe4b8
commit 258d7e05d6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
basis/models/models-docs.factor
View File

@ -5,11 +5,11 @@ IN: models
HELP: model
{ $class-description "A mutable cell holding a single value. When the value is changed, a sequence of connected objects are notified. Models have the following slots:"
{ $slots
{ "value" "the value of the model. Use " { $link set-model } " to change the value." }
{ "connections" "a sequence of objects implementing the " { $link model-changed } " generic word, to be notified when the model's value changes." }
{ "dependencies" "a sequence of models which should have this model added to their sequence of connections when activated." }
{ "ref" "a reference count tracking the number of models which depend on this one." }
{ "locked?" "a slot set by " { $link with-locked-model } " to ensure that the model doesn't get changed recursively" }
{ "value" { "the value of the model. Use " { $link set-model } " to change the value." } }
{ "connections" { "a sequence of objects implementing the " { $link model-changed } " generic word, to be notified when the model's value changes." } }
{ "dependencies" { "a sequence of models which should have this model added to their sequence of connections when activated." } }
{ "ref" { "a reference count tracking the number of models which depend on this one." } }
{ "locked?" { "a slot set by " { $link with-locked-model } " to ensure that the model doesn't get changed recursively" } }
}
"Other classes may inherit from " { $link model } "."
} ;