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


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)

REGTYPE: bar/1:

Usage: bar(X)

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)

Usage 2: list(L)

PREDICATE: q/1:

Usage 1: q(A)

Usage 2: q(A)

PREDICATE: q/2:

The predicate is of type dynamic.

Usage 1:

Usage 2:

PREDICATE: r/1:

The predicate is of type data.

Usage: r(A)

PREDICATE: og/1:

No further documentation available for this predicate.

PREDICATE: t/5:

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

PREDICATE: u/3:

Usage 2:

PREDICATE: w/1:

PREDICATE: p/5:

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

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)

REGTYPE: list/1:

Usage 1: list(L)

Usage 2: list(L)

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:

Usage 1: * ISO *

Usage 2: p(Preds,Value,Assoc)

Usage 3:

Documentation on internals (example_module)

PREDICATE: s/1:

Usage: s(A)

REGTYPE: list/2:

Usage 1: list(L,T)

Usage 2: list(L,T)

MODE: og/2:

Usage: og(A,T)

PREDICATE: is/2:

Usage: Num is Expr


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