quick documentation for block_diagram

This commit is contained in:
Theofrastos Mantadelis 2010-11-23 13:24:05 +01:00
parent ccc1fee7ae
commit 813b15d022

View File

@ -1,4 +1,4 @@
´a\input texinfo @c -*- mode: texinfo; coding: latin-1; -*-
<EFBFBD>a\input texinfo @c -*- mode: texinfo; coding: latin-1; -*-
@c %**start of header
@setfilename yap.info
@ -10481,14 +10481,14 @@ integers then @var{NUMBER} will also be an integer, otherwise
@syindex randseq/3
@cnindex randseq/3
Unify @var{Numbers} with a list of @var{LENGTH} unique random integers
in the range @code{[1 ...@var{MAX})}.
in the range @code{[1<EFBFBD>...@var{MAX})}.
@item randset(+@var{LENGTH}, +@var{MAX}, -@var{Numbers})
@findex randset/3
@syindex randset/3
@cnindex randset/3
Unify @var{Numbers} with an ordered list of @var{LENGTH} unique random
integers in the range @code{[1 ...@var{MAX})}.
integers in the range @code{[1<EFBFBD>...@var{MAX})}.
@item setrand(+@var{Key})
@findex setrand/1
@ -12880,6 +12880,31 @@ are released.
@end table
@node Block Diagram, Library
@section Block Diagram
@cindex Block Diagram
This library provides a way of visualizing a prolog program using modules with blocks.
To use it use: @code{:-use_module(library(block_diagram))}.
@table @code
@item make_diagram(+inputfilename, +ouputfilename)
@findex make_diagram/2
@snindex make_diagram/2
@cnindex make_diagram/2
This will crawl the files following the use_module, ensure_loaded directives withing the inputfilename.
The result will be a file in dot format.
You can make a pdf at the shell by asking @code{dot -Tpdf filename > output.pdf}.
@item make_diagram(+inputfilename, +ouputfilename, +predicate, +depth, +extension)
@findex make_diagram/2
@snindex make_diagram/2
@cnindex make_diagram/2
The same as @code{make_diagram/2} but you can define how many of the imported/exporeted predicates will be shown with predicate, and how deep the crawler is allowed to go with depth. The extension is used if the file use module directives do not include a file extension.
@end table
@node SWI-Prolog, SWI-Prolog Global Variables, Library, Top
@cindex SWI-Prolog