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.

Sign up for GitHub

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

Improve developer documentation v2 #2750

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
dfcb7cd
Describe the aim of the documentation marked as "For contributors"
Aug 13, 2018
2ea73b8
Move "Tutorial" section to the right place
Aug 13, 2018
37128c0
Improve how a sentence reads
Aug 13, 2018
2034faf
Move two items out of list
Aug 13, 2018
c423bb6
Add links to module level documentation
Aug 13, 2018
90e43d9
Fix "#" being converted to "::" in doxygen
Aug 14, 2018
3b74238
Fix apostrophe
Aug 14, 2018
d924247
Add in empty lines after headings
Aug 14, 2018
3eee998
Add references to class-level documentation
Aug 14, 2018
147c5d9
Add header for orphaned diagram
Aug 14, 2018
35e278e
Move docs from guide to module-level docs
Aug 14, 2018
96dc0a3
Fix minor typos
Aug 14, 2018
124d012
Combined many pages of developer docs into one
Aug 14, 2018
0695df6
Switch one file from ## to using sections
Aug 14, 2018
ccaa87c
Move examples from code-walkthrough to linked module
Aug 15, 2018
f7bcd0a
Move java_bytecode explanations to module doc
Aug 15, 2018
d6755b0
Move solvers API description to solvers module
Aug 15, 2018
0661075
Delete one word ('testing')
Aug 15, 2018
0b7c4fb
Add sections to java_bytecode/README.md
Aug 16, 2018
ccf3c50
Add outline to module docs
Aug 16, 2018
794ba03
Change heading in java-bytecode docs
Aug 16, 2018
544671e
Move 'Flattening' section in solvers/README.md
Aug 16, 2018
76dbb2a
Remove links to classes from high level overview
Aug 20, 2018
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
2 changes: 1 addition & 1 deletion doc/architectural/bmct-class.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

## equation ##

To be documented.
See \ref symex-overview.
30 changes: 1 addition & 29 deletions doc/architectural/data-structures-from-ast-to-goto-program.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,7 @@

## goto_programt ##

See \ref goto_programt.

### instructiont ###

See [instructiont](\ref goto_programt::instructiont).

#### Types, motivation of each type #####

See [instructiont](\ref goto_programt::instructiont).

#### Accepted code (codet) values ####

To be documented.

#### Accepted guard (exprt) values ####

To be documented.

## goto_functionst ##

\ref goto_functionst is a map from function names to function bodies (CFGs).

To be documented.

## goto_modelt ##

\ref goto_modelt is a compilation unit.

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

## Example: ##

Expand Down
20 changes: 14 additions & 6 deletions doc/architectural/front-end-languages-generating-codet-from-multiple-languages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,32 @@

## language_uit, language_filest, languaget classes: ##

### Purpose ###

To be documented.
See \ref langapi.

### Parse ###
Copy link
Member

Choose a reason for hiding this comment

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

Can be removed.


To be documented.
See \ref language_uit::parse().

### Typecheck ###
Copy link
Member

Choose a reason for hiding this comment

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

Can be removed.


To be documented.
See \ref language_uit::typecheck().

### Final ###
Copy link
Member

Choose a reason for hiding this comment

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

Can be removed.


To be documented.
See \ref language_uit::final().

## C ##

See \ref ansi-c.

## C++ ##

See \ref cpp.

## Java bytecode ##

See \ref java_bytecode.

### Explain how a java program / class is represented in a .class ###
Copy link
Member

Choose a reason for hiding this comment

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

Should be explained in java_bytecode


To be documented.
Expand Down
2 changes: 2 additions & 0 deletions doc/architectural/solvers-infrastructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

\author

See \ref solvers-overview.

## Flattening ##
Copy link
Member

Choose a reason for hiding this comment

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

Can be removed.


To be documented.
Expand Down
3 changes: 2 additions & 1 deletion doc/architectural/static-analysis-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@

\author

To be documented.

See \ref analyses and \ref pointer-analysis.
4 changes: 2 additions & 2 deletions doc/architectural/symbolic-executors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

\author

## Symex class ##
## Symbolic execution ##

To be documented.
See \ref symex-overview.