basis/tools/destructors/destructors-docs.factor

   1 ! Copyright (C) 2009 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax help.tips quotations destructors ;
   4 IN: tools.destructors
   5
   6 HELP: disposables.
   7 { $description "Print the number of disposable objects of each class." } ;
   8
   9 HELP: leaks
  10 { $values
  11     { "quot" quotation }
  12 }
  13 { $description "Runs a quotation, printing any increases in the number of disposable objects after the quotation returns. The " { $link debug-leaks? } " variable is also switched on while the quotation runs, recording the current continuation in every newly-created disposable object." } ;
  14
  15 TIP: "Use the " { $link leaks } " combinator to track down resource leaks." ;
  16
  17 ARTICLE: "tools.destructors" "Destructor tools"
  18 "The " { $vocab-link "tools.destructors" } " vocabulary provides words for tracking down resource leaks."
  19 { $subsection debug-leaks? }
  20 { $subsection disposables. }
  21 { $subsection leaks }
  22 { $see-also "destructors" } ;
  23
  24 ABOUT: "tools.destructors"