Skip to content

Improve developer documentation v2 #2750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Aug 21, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions doc/architectural/code-walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,10 @@ testing
The core structures used for representing abstract syntax trees are all
documented in \ref util.

\subsection ast-examples-section Examples: how to represent the AST of statements, in C and in java

\subsubsection ast-example-1-section x = y + 123

To be documented..

\subsubsection ast-example-2-section if (x > 10) { y = 2 } else { v[3] = 4 }

To be documented.

\subsubsection ast-example-3-section Java arrays: struct Array { int length, int *data };

To be documented.


\section data-structures-from-ast-to-goto-program-section Data structures: from AST to GOTO program

\subsection goto-programt-section goto_programt

See \ref goto-programs, \ref goto_programt and [instructiont](\ref goto_programt::instructiont).

\subsection goto-program-example-section Example:

\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; }

To be documented.


\section front-end-languages-generating-codet-from-multiple-languages-section Front-end languages: generating codet from multiple languages

\subsection language-uit-section language_uit, language_filest, languaget classes:
Expand Down
6 changes: 6 additions & 0 deletions src/goto-programs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,3 +371,9 @@ previous stage:
block.

This stage concludes the *analysis-independent* program transformations.

\subsection goto-program-example-section Example:

\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; }

To be documented.
14 changes: 14 additions & 0 deletions src/util/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,17 @@ digraph G {
2 -> 3 [label="Command line options, file names"];
}
\enddot

\subsection ast-examples-section Examples: how to represent the AST of statements, in C and in java
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AST-related things might be better located in the context of language frontends (this is langapi, for now).


\subsubsection ast-example-1-section x = y + 123

To be documented..

\subsubsection ast-example-2-section if (x > 10) { y = 2 } else { v[3] = 4 }

To be documented.

\subsubsection ast-example-3-section Java arrays: struct Array { int length, int *data };

To be documented.