Skip to content

Commit 124d012

Browse files
author
Owen Jones
committed
Combined many pages of developer docs into one
Also started using \section, \subsection etc instead of #, ## and ###
1 parent 96dc0a3 commit 124d012

9 files changed

+118
-133
lines changed

doc/architectural/bmct-class.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

doc/architectural/code-walkthrough.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
\ingroup module_hidden
2+
\page code-walkthrough Code Walkthrough
3+
4+
\author Cesar Rodriguez, Owen Jones
5+
6+
testing
7+
8+
\section data-structures-core-structures-and-ast-section Data structures: core structures and AST
9+
10+
The core structures used for representing abstract syntax trees are all
11+
documented in \ref util.
12+
13+
\subsection ast-examples-section Examples: how to represent the AST of statements, in C and in java
14+
15+
\subsubsection ast-example-1-section x = y + 123
16+
17+
To be documented..
18+
19+
\subsubsection ast-example-2-section if (x > 10) { y = 2 } else { v[3] = 4 }
20+
21+
To be documented.
22+
23+
\subsubsection ast-example-3-section Java arrays: struct Array { int length, int *data };
24+
25+
To be documented.
26+
27+
28+
\section data-structures-from-ast-to-goto-program-section Data structures: from AST to GOTO program
29+
30+
\subsection goto-programt-section goto_programt
31+
32+
See \ref goto-programs, \ref goto_programt and [instructiont](\ref goto_programt::instructiont).
33+
34+
\subsection goto-program-example-section Example:
35+
36+
\subsubsection goto-program-example-1-section Unsigned mult (unsigned a, unsigned b) { int acc, i; for (i = 0; i < b; i++) acc += a; return acc; }
37+
38+
To be documented.
39+
40+
41+
\section front-end-languages-generating-codet-from-multiple-languages-section Front-end languages: generating codet from multiple languages
42+
43+
\subsection language-uit-section language_uit, language_filest, languaget classes:
44+
45+
See \ref langapi.
46+
47+
\subsubsection parse-section Parse
48+
49+
See \ref language_uit::parse().
50+
51+
\subsubsection typecheck-section Typecheck
52+
53+
See \ref language_uit::typecheck().
54+
55+
\subsubsection final-section Final
56+
57+
See \ref language_uit::final().
58+
59+
\subsection languages-c-section C
60+
61+
See \ref ansi-c.
62+
63+
\subsection languages-cpp-section C++
64+
65+
See \ref cpp.
66+
67+
\subsection languages-java-section Java bytecode
68+
69+
See \ref java_bytecode.
70+
71+
\subsubsection java-class-section Explain how a java program / class is represented in a .class
72+
73+
To be documented.
74+
75+
\subsubsection java-bytecode-conversion-section Explain the 2 step conversion from bytecode to codet
76+
77+
To be documented.
78+
79+
\subsubsection java-bytecode-conversion-example-section A worked example of converting java bytecode to codet
80+
81+
To be documented.
82+
83+
84+
\section bmct-class-section Bmct class
85+
86+
\subsection equation-section equation
87+
88+
See \ref symex-overview.
89+
90+
91+
\section symbolic-executors-section Symbolic executors
92+
93+
\subsection symbolic-execution-section Symbolic execution
94+
95+
See \ref symex-overview.
96+
97+
98+
\section solvers-infrastructure-section Solvers infrastructure
99+
100+
See \ref solvers-overview.
101+
102+
\subsection flattening-section Flattening
103+
104+
To be documented.
105+
106+
\subsection smt-solving-api-section SMT solving API
107+
108+
To be documented.
109+
110+
\subsection sat-solving-api-section SAT solving API
111+
112+
To be documented.
113+
114+
115+
\section static-analysis-apis-section Static analysis APIs
116+
117+
See \ref analyses and \ref pointer-analysis.

doc/architectural/data-structures-core-structures-and-ast.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

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

Lines changed: 0 additions & 14 deletions
This file was deleted.

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

Lines changed: 0 additions & 44 deletions
This file was deleted.

doc/architectural/front-page.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,7 @@ class-level or module-level documentation.
8080

8181
* \subpage folder-walkthrough
8282

83-
* \subpage data-structures-core-structures-and-ast
84-
85-
* \subpage data-structures-from-ast-to-goto-program
86-
87-
* \subpage front-end-languages-generating-codet-from-multiple-languages
88-
89-
* \subpage bmct-class
90-
91-
* \subpage symbolic-executors
92-
93-
* \subpage solvers-infrastructure
94-
95-
* \subpage static-analysis-apis
83+
* \subpage code-walkthrough
9684

9785
* \subpage other-tools
9886

doc/architectural/solvers-infrastructure.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

doc/architectural/static-analysis-apis.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

doc/architectural/symbolic-executors.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)