Skip to content

Commit c423bb6

Browse files
author
Owen
committed
Add links to module level documentation
1 parent 2034faf commit c423bb6

6 files changed

+22
-39
lines changed

doc/architectural/bmct-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

66
## equation ##
77

8-
To be documented.
8+
See \ref symex-overview.

doc/architectural/data-structures-from-ast-to-goto-program.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,7 @@
55

66
## goto_programt ##
77

8-
See \ref goto_programt.
9-
10-
### instructiont ###
11-
12-
See [instructiont](\ref goto_programt::instructiont).
13-
14-
#### Types, motivation of each type #####
15-
16-
See [instructiont](\ref goto_programt::instructiont).
17-
18-
#### Accepted code (codet) values ####
19-
20-
To be documented.
21-
22-
#### Accepted guard (exprt) values ####
23-
24-
To be documented.
25-
26-
## goto_functionst ##
27-
28-
\ref goto_functionst is a map from function names to function bodies (CFGs).
29-
30-
To be documented.
31-
32-
## goto_modelt ##
33-
34-
\ref goto_modelt is a compilation unit.
35-
36-
To be documented.
8+
See \ref goto-programs, \ref goto_programt and [instructiont](\ref goto_programt::instructiont).
379

3810
## Example: ##
3911

doc/architectural/front-end-languages-generating-codet-from-multiple-languages.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,32 @@
55

66
## language_uit, language_filest, languaget classes: ##
77

8-
### Purpose ###
9-
10-
To be documented.
8+
See \ref langapi.
119

1210
### Parse ###
1311

14-
To be documented.
12+
See \ref language_uit::parse().
1513

1614
### Typecheck ###
1715

18-
To be documented.
16+
See \ref language_uit::typecheck().
1917

2018
### Final ###
2119

22-
To be documented.
20+
See \ref language_uit::final().
21+
22+
## C ##
23+
24+
See \ref ansi-c.
25+
26+
## C++ ##
27+
28+
See \ref cpp.
2329

2430
## Java bytecode ##
2531

32+
See \ref java_bytecode.
33+
2634
### Explain how a java program / class is represented in a .class ###
2735

2836
To be documented.

doc/architectural/solvers-infrastructure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
\author
55

6+
See \ref solvers-overview.
7+
68
## Flattening ##
79

810
To be documented.

doc/architectural/static-analysis-apis.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33

44
\author
55

6-
To be documented.
6+
7+
See \ref analyses and \ref pointer-analysis.

doc/architectural/symbolic-executors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
\author
55

6-
## Symex class ##
6+
## Symbolic execution ##
77

8-
To be documented.
8+
See \ref symex-overview.

0 commit comments

Comments
 (0)