factor/basis/tools/destructors/destructors-docs.factor

34 lines
1.1 KiB
Factor

! Copyright (C) 2009 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
USING: destructors help.markup help.syntax quotations sequences ;
IN: tools.destructors
HELP: disposables.
{ $description "Print the number of disposable objects of each class." } ;
HELP: leaks.
{ $values
{ "quot" quotation }
}
{ $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." } ;
HELP: leaks
{ $values
{ "quot" quotation }
{ "disposables" sequence }
}
{ $description
"Runs the quotation and collects all disposables leaked by it. Used by " { $link leaks. } "."
} ;
ARTICLE: "tools.destructors" "Destructor tools"
"The " { $vocab-link "tools.destructors" } " vocabulary provides words for tracking down resource leaks."
{ $subsections
debug-leaks?
disposables.
leaks.
}
{ $see-also "destructors" } ;
ABOUT: "tools.destructors"