]> gitweb.factorcode.org Git - factor.git/blob - core/classes/singleton/singleton-docs.factor
Merge branch 'master' into experimental
[factor.git] / core / classes / singleton / singleton-docs.factor
1 USING: help.markup help.syntax kernel words ;
2 IN: classes.singleton
3
4 ARTICLE: "singletons" "Singleton classes"
5 "A singleton is a class with only one instance and with no state."
6 { $subsection POSTPONE: SINGLETON: }
7 { $subsection POSTPONE: SINGLETONS: }
8 { $subsection define-singleton-class }
9 "The set of all singleton classes is itself a class:"
10 { $subsection singleton-class? }
11 { $subsection singleton-class } ;
12
13 HELP: define-singleton-class
14 { $values { "word" "a new word" } }
15 { $description
16     "Defines a singleton class. This is the run-time equivalent of " { $link POSTPONE: SINGLETON: } "." } ;
17
18 { POSTPONE: SINGLETON: define-singleton-class } related-words
19
20 HELP: singleton-class
21 { $class-description "The class of singleton classes." } ;
22
23 ABOUT: "singletons"