Auto Documenter Output for the Example Module

Author(s): Alan Robinson, David H.D. Warren.

Version: 0.1#3 (2001/1/2)

This is where general comments on the file go. In this case the file is a library which contains some assertion examples for testing the automatic documentation system.

• Usage and interface (example_module)
• Documentation on exports (example_module)
• Documentation on multifiles (example_module)
• Documentation on internals (example_module)

Usage and interface (example_module)

Documentation on exports (example_module)

REGTYPE: bar/1:

Usage: bar(X)

• Description: X is an acceptable kind of bar.

REGTYPE: baz/1:

A regular type, defined as follows:

baz(a).
baz(b).

REGTYPE: aorb/1:

A regular type, defined as follows:

aorb(a).
aorb(b).

REGTYPE: tree_of/2:

A regular type, defined as follows:

tree_of(_1,void).
tree_of(T,tree(_1,_2,_3)) :-
        call(T,_1),
        tree_of(T,_2),
        tree_of(T,_3).

REGTYPE: list_or_aorb/2:

A regular type, defined as follows:

list_or_aorb(T,_1) :-
        list(T,_1).
list_or_aorb(_T,_1) :-
        aorb(_1).

REGTYPE: list/1:

Usage 1: list(L)

• Description: L is a list.

Usage 2: list(L)

• Description: L is a list.

PREDICATE: q/1:

Usage 1: q(A)

• Description: Foo
• The following properties should hold at call time: A is a list. (list/1)
• The following properties should hold upon exit: A is a list. (list/1) A is ground. (gnd/1)
• The following properties should hold globally: All the calls of the form q(A) do not fail. (not_fails/1)

Usage 2: q(A)

• Description: Not a bad use at all.

PREDICATE: q/2:

The predicate is of type dynamic.

Usage 1:

• The following properties should hold at call time: Arg1 is a free variable. (var/1) Arg2 is ground. (gnd/1) Arg2 is an integer. (int/1)
• The following properties should hold upon exit: Arg1 is ground. (gnd/1) Arg1 is an integer. (int/1) Arg2 is an integer. (int/1)

Usage 2:

• Description: Non-moded types are best used this way.
• Call and exit should be compatible with: Arg1 is an integer. (int/1) Arg2 is a list. (list/1)

PREDICATE: r/1:

The predicate is of type data.

Usage: r(A)

• Description: This uses parametric types
• The following properties should hold at call time: A is a list. (list/1)
• The following properties should hold upon exit: A is a list of ints. (list/2) A is ground. (gnd/1)
• The following properties should hold globally: All the calls of the form r(A) do not fail. (not_fails/1)

PREDICATE: og/1:

No further documentation available for this predicate.

PREDICATE: t/5:

Usage: t(+A,-B,?(C),@(D),og(E))

• Description: This predicate uses modes extensively.
• Call and exit should be compatible with: +A is a list. (list/1) -B is a list. (list/1) ?(C) is an integer. (int/1) @(D) is an integer. (int/1) og(E) is a list. (list/1)
• The following properties should hold at call time: B is rather long. (long/1)
• The following properties should hold upon exit: C is ground. (gnd/1) A is ground. (gnd/1)
• The following properties should hold globally: All the calls of the form t(+A,-B,?(C),@(D),og(E)) do not fail. (not_fails/1)

PREDICATE: u/3:

Usage 2:

• Call and exit should be compatible with: Arg1 is an integer. (int/1) Arg2 is a list of mytypes. (list/2) Arg3 is an integer. (int/1)

PREDICATE: w/1:

PREDICATE: p/5:

Usage: p(og(int),in,@(list(int)),-,+A)

• The following properties should hold globally: 1+length(A) is a lower bound on the cost of any call of the form p(og(int),in,@(list(int)),-,+A). (steps_lb/2)

PROPERTY: long/1:

This is a property, describing a list that is longish. The definition is:

long(L) :-
        length(L,N),
        N>100.

Usage: long(L)

• Description: L is rather long.

REGTYPE: list/1:

Usage 1: list(L)

• Description: L is a list.

Usage 2: list(L)

• Description: L is a list.

Documentation on multifiles (example_module)

PREDICATE: p/3:

A general comment on the predicate.

The predicate is multifile.

The predicate is of type dynamic.

General properties:

• If the following properties hold at call time: Arg1 is ground. (gnd/1) Arg2 is a free variable. (var/1) Arg3 is a free variable. (var/1)

• The following properties should hold at call time: foo(Arg1) (undefined property) Arg2 is an acceptable kind of bar. (bar/1) baz(Arg3) (baz/1)

• If the following properties hold at call time: Arg1 is an integer. (int/1) Arg2 is an integer. (int/1) Arg3 is a free variable. (var/1) then the following properties should hold upon exit: Arg1 is an integer. (int/1) Arg2 is an integer. (int/1) Arg3 is ground. (gnd/1)

• If the following properties hold at call time: Arg1 is an integer. (int/1) Arg2 is an integer. (int/1) Arg3 is a free variable. (var/1) then the following properties should hold globally: All the calls of the form p(Arg1,Arg2,Arg3) do not fail. (not_fails/1)

Usage 1: * ISO *

• Description: This mode is nice.
• The following properties should hold at call time: Arg1 is an integer. (int/1) Arg2 is an integer. (int/1) Arg3 is a free variable. (var/1)
• The following properties should hold upon exit: Arg1 is an integer. (int/1) Arg2 is an integer. (int/1) Arg3 is a list. (list/1)
• The following properties should hold globally: Complies with the ISO-Prolog standard. (iso/1) All the calls of the form p(Arg1,Arg2,Arg3) do not fail. (not_fails/1)

Usage 2: p(Preds,Value,Assoc)

• Description: This mode is also nice.
• The following properties should hold at call time: Preds is a free variable. (var/1) Value is a free variable. (var/1) Assoc is a list. (list/1)
• The following properties should hold upon exit: Preds is an integer. (int/1) Value is an integer. (int/1) Assoc is a list. (list/1)
• The following properties should hold globally: All the calls of the form p(Preds,Value,Assoc) do not fail. (not_fails/1)

Usage 3:

• Description: Just playing around.
• The following properties should hold upon exit: Arg1 is a list. (list/1) Arg2 is an integer. (int/1) Arg3 is a list. (list/1)
• The following properties should hold globally: All the calls of the form p(Arg1,Arg2,Arg3) do not fail. (not_fails/1) All the calls of the form p(Arg1,Arg2,Arg3) do not fail. (not_fails/1)

Documentation on internals (example_module)

PREDICATE: s/1:

Usage: s(A)

• The following properties should hold at call time: A is a list. (list/1)
• The following properties should hold upon exit: A is a list. (list/1) A is ground. (gnd/1)
• The following properties should hold globally: All the calls of the form s(A) do not fail. (not_fails/1)

REGTYPE: list/2:

Usage 1: list(L,T)

• Description: L is a list of Ts.

Usage 2: list(L,T)

• Description: L is a list of Ts.

MODE: og/2:

Usage: og(A,T)

• Description: This is a parametric mode definition.
• Call and exit are compatible with: call(T,A) (undefined property)
• The following properties are added upon exit: A is ground. (gnd/1)

PREDICATE: is/2:

Usage: Num is Expr

• Description: Typical way to describe/document an external predicate (e.g., written in C).
• The following properties should hold at call time: Expr is an arithmetic expression. (arithexpression/1)
• The following properties hold upon exit: Num is a number. (num/1)

Go to the first, previous, next, last section, table of contents.