work/software/boot/doc.pro at master · edom/work · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/** <module> Source code documentation system
*/

/** documentation(?Thing,?Documentation) is nondet.

The documentation of Thing is Documentation.

Thing may be:

    - module(Module)

    - predicate(Module,Name,Arity)

Documentation syntax and semantics:

    - summary-Markup
    Markup is a markup.

    - detail-Markup
    Markup is a markup.

Markup:

    - List
    Concatenation.
    List is a list of Documentation.

    - string(String)
    Verbatim output.
    String is a string/1.

    - link(Thing)
    Internal link to Thing.

Documentation is designed for clarity of semantics and translatability to other formats,
not for convenience of authoring.
*/

:- multifile documentation/2.
:- dynamic documentation/2.

documentation_property(Thing, Key, Value) :-
    documentation(Thing, List),
    member(Key-Value, List).

/** thing_summary(?Thing, -Summary) is det.
*/

thing_summary(Thing, Summary) :- documentation_property(Thing, summary, Summary), !.
thing_summary(_, empty).

:- include("imperative.pro").
:- include("internal/doc_browse.pro").