extra/classes/prettyprinter/prettyprinter-docs.factor

   1 ! Copyright (C) 2023 Jean-Marc Lugrin.
   2 ! See https://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax ;
   4 IN: classes.prettyprinter
   5
   6 ARTICLE: "classes.prettyprinter" "Print the hierarchy of a class"
   7 { $vocab-link "classes.prettyprinter" } " supports the printing of the class hierarchy to the listener or to any text stream." $nl
   8 "The class name and vocab name are clickable, a P indicates that the classs is PRIVATE." $nl
   9 "See " { $link hierarchy. } "."
  10 ;
  11
  12 HELP: hierarchy.
  13 { $values { "class" "a class, use " { $snippet "tuple" } " to print the whole hierarchy" }  }
  14 { $description "Print the class hierarchy layout on the output stream, with the name of its vocabulary." }
  15 { $errors "Throws an error if " { $snippet "class" } " is not a class." }
  16 { $examples
  17     { $unchecked-example "tuple hierarchy." }
  18     { $unchecked-example " \"GADGETS.TXT\" utf8 [ gadget hierarchy. ] with-file-writer" }
  19 }
  20 ;
  21
  22 HELP: class-hierarchy
  23 { $values { "hash" "An " { $snippet "hashtable" } " mapping classes to list of children" }  }
  24 { $description "Extract the hierarchy of all classes in the form of an hashtable"
  25     "with the class as the key and a vector of all children class in alphabetic order as a child." }
  26 { $notes { "This is made public for other tools that want to explore the class hierarch." } }
  27 ;
  28
  29 HELP: not-a-class-error
  30 { $description "Throws a " { $link not-a-class-error } "." }
  31 { $error-description "Thrown by " { $link hierarchy. } " if the parameter is not a class." }
  32 ;
  33
  34 ABOUT: "classes.prettyprinter"