Skip to content

Commit 0e1bb07

Browse files
author
svorenova
authored
Merge pull request #2823 from svorenova/doc_readme_typet
Add typet and symbol_typet documentation to util README [DOC-12]
2 parents 3e9b76d + 5e55787 commit 0e1bb07

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/util/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ CPROVER codebase.
1515
See detailed documentation at \ref irept.
1616

1717
[irept](\ref irept)s are generic tree nodes. You
18-
should think of each node as holding a single string ([data](irept::data),
18+
should think of each node as holding a single string ([data](\ref irept::data),
1919
actually an \ref irep_idt) and lots of child nodes, some of which are numbered
2020
([sub](\ref irept::dt::sub)) and some of which are labelled, and the label
2121
can either start with a “\#” ([comments](\ref irept::dt::comments)) or without
@@ -101,15 +101,15 @@ See documentation at \ref dstringt.
101101

102102
\subsection typet_section typet
103103

104-
See \ref typet.
105-
106-
To be documented.
104+
\ref typet represents the type of an expression. Types may have subtypes,
105+
stored in two [sub](\ref irept::dt::sub)s named “subtype” (a single type) and
106+
“subtypes” (a vector of types). For pre-defined types see `std_types.h` and
107+
`mathematical_types.h`.
107108

108109
\subsubsection symbol_typet_section symbol_typet
109110

110-
See \ref symbol_typet.
111-
112-
To be documented.
111+
\ref symbol_typet is a type used to store a reference to the symbol table. The
112+
full \ref symbolt can be retrieved using the identifier of \ref symbol_typet.
113113

114114
\subsection exprt_section exprt
115115

0 commit comments

Comments
 (0)