core/classes/singleton/singleton-docs.factor

   1 USING: help.markup help.syntax ;
   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 { $subsections
   7     POSTPONE: SINGLETON:
   8     POSTPONE: SINGLETONS:
   9     define-singleton-class
  10 }
  11 "The set of all singleton classes is itself a class:"
  12 { $subsections
  13     singleton-class?
  14     singleton-class
  15 } ;
  16
  17 HELP: define-singleton-class
  18 { $values { "word" "a new word" } }
  19 { $description
  20     "Defines a singleton class. This is the run-time equivalent of " { $link POSTPONE: SINGLETON: } "." } ;
  21
  22 { POSTPONE: SINGLETON: define-singleton-class } related-words
  23
  24 HELP: singleton-class
  25 { $class-description "The class of singleton classes." } ;
  26
  27 ABOUT: "singletons"