Add documentation for the central data structures in CBMC IR#7470

Merged

NlightNFotis merged 22 commits intodiffblue:developfrom

NlightNFotis:docs_goto_programs

Feb 7, 2023

Commits on Feb 3, 2023

Add documentation for the central data structures in CBMC IR (goto-programs).

NlightNFotis
authored and
thomasspriggs
committed
Change the wording to closer correspond to C++ types and concepts

NlightNFotis
authored and
thomasspriggs
committed
Consistently refer to GOTO as GOTO
thomasspriggs
committed
Correct tense of `used` to `use`.
thomasspriggs
committed
Clarify what `goto_modelt` is used for
thomasspriggs
committed
Replace "main" with "top level" in goto model explaination
thomasspriggs
committed
Add mermaid diagram support to documentation site build
thomasspriggs
committed
Add goto model entity relationship diagram
thomasspriggs
committed
Make central-data-structures a subpage of the architecture page
thomasspriggs
committed
Correct "list of GOTO functions" to "collection"
thomasspriggs
committed
Reword description of the symbol table
thomasspriggs
committed
Remove pseudocode from the description of `goto_programt`
thomasspriggs
committed
Reword description of goto program
thomasspriggs
committed
Add explaination of heirarchy of goto model classes
thomasspriggs
committed
Show that `goto_functionst` is a map not a list
thomasspriggs
committed
Reword explaination of symbol table
thomasspriggs
committed
Add links to `symbolt` and `symbol_exprt` classes
thomasspriggs
committed
Note optional nature of goto program bodies
thomasspriggs
committed
Separate the documentation of the `irept` class
thomasspriggs
committed
Provide more extensive overview of `irept` itself
thomasspriggs
committed
Add link to goto program documentation from central data structures
thomasspriggs
committed
Replace relative link with web link
thomasspriggs
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add documentation for the central data structures in CBMC IR#7470

Commits on Feb 3, 2023

Add documentation for the central data structures in CBMC IR (goto-programs).

Change the wording to closer correspond to C++ types and concepts

Consistently refer to GOTO as GOTO

Correct tense of `used` to `use`.

Clarify what `goto_modelt` is used for

Replace "main" with "top level" in goto model explaination

Add mermaid diagram support to documentation site build

Add goto model entity relationship diagram

Make central-data-structures a subpage of the architecture page

Correct "list of GOTO functions" to "collection"

Reword description of the symbol table

Remove pseudocode from the description of `goto_programt`

Reword description of goto program

Add explaination of heirarchy of goto model classes

Show that `goto_functionst` is a map not a list

Reword explaination of symbol table

Add links to `symbolt` and `symbol_exprt` classes

Note optional nature of goto program bodies

Separate the documentation of the `irept` class

Provide more extensive overview of `irept` itself

Add link to goto program documentation from central data structures

Replace relative link with web link