Skip to content

Commit 6b0dfb6

Browse files
author
Owen
committed
Wrap lines properly
1 parent ae66e65 commit 6b0dfb6

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

src/util/dstring.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Author: Daniel Kroening, [email protected]
1616

1717
#include "string_container.h"
1818

19-
/// \ref dstringt has one field, an unsigned integer \ref no which is an index into
20-
/// a static table of strings. This makes it expensive to create a new string
21-
/// (because you have to look through the whole table to see if it is already
22-
/// there, and add it if it isn't) but very cheap to compare strings (just
23-
/// compare the two integers). It also means that when you have lots of copies
24-
/// of the same string you only have to store the whole string once, which
25-
/// saves space.
19+
/// \ref dstringt has one field, an unsigned integer \ref no which is an index
20+
/// into a static table of strings. This makes it expensive to create a new
21+
/// string(because you have to look through the whole table to see if it is
22+
/// already there, and add it if it isn't) but very cheap to compare strings
23+
/// (just compare the two integers). It also means that when you have lots of
24+
/// copies of the same string you only have to store the whole string once,
25+
/// which saves space.
2626
///
2727
/// `irep_idt` and `irep_namet` are typedef-ed to \ref dstringt in irep.h unless
2828
/// `USE_STD_STRING` is set.

src/util/irep.h

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -92,19 +92,21 @@ const irept &get_nil_irep();
9292
/// it is by default - see the `SHARING` macro) a basic unit of data (of type
9393
/// \ref dt) which contains four things:
9494
///
95-
/// * \ref irept::dt::data : A string, which is returned when the \ref id() function is used.
96-
/// (Unless `USE_STD_STRING` is set, this is actually a \ref dstringt and thus
97-
/// an integer which is a reference into a string table.)
95+
/// * \ref irept::dt::data : A string, which is returned when the \ref id()
96+
/// function is used. (Unless `USE_STD_STRING` is set, this is actually a
97+
/// \ref dstringt and thus an integer which is a reference into a string
98+
/// table.)
9899
///
99-
/// * \ref irept::dt::named_sub : A map from `irep_namet` (a string) to \ref irept. This
100-
/// is used for named children, i.e. subexpressions, parameters, etc.
100+
/// * \ref irept::dt::named_sub : A map from `irep_namet` (a string) to \ref
101+
/// irept. This is used for named children, i.e. subexpressions, parameters,
102+
/// etc.
101103
///
102-
/// * \ref irept::dt::comments : Another map from `irep_namet` to \ref irept which is used
103-
/// for annotations and other ‘non-semantic’ information. Note that this
104-
/// map is ignore by the default \ref operator==.
104+
/// * \ref irept::dt::comments : Another map from `irep_namet` to \ref irept
105+
/// which is used for annotations and other ‘non-semantic’ information. Note
106+
/// that this map is ignore by the default \ref operator==.
105107
///
106-
/// * \ref irept::dt::sub : A vector of \ref irept which is used to store ordered but
107-
/// unnamed children.
108+
/// * \ref irept::dt::sub : A vector of \ref irept which is used to store
109+
/// ordered but unnamed children.
108110
///
109111
/// The \ref irept::pretty function outputs the explicit tree structure of
110112
/// an \ref irept and can be used to understand and debug problems with
@@ -129,19 +131,19 @@ const irept &get_nil_irep();
129131
/// point for working out how to manipulate data.
130132
///
131133
/// There are three main groups of classes (or APIs); those derived from
132-
/// \ref typet, \ref codet and \ref exprt respectively. Although all of these inherit
133-
/// from \ref irept, these are the most abstract level that code should handle
134-
/// data. If code is manipulating plain `irept`s then something is wrong
134+
/// \ref typet, \ref codet and \ref exprt respectively. Although all of these
135+
/// inherit from \ref irept, these are the most abstract level that code should
136+
/// handle data. If code is manipulating plain `irept`s then something is wrong
135137
/// with the architecture of the code.
136138
///
137-
/// Many of the key descendants of \ref exprt are declared in \ref std_expr.h. All
138-
/// expressions have a named subexpression with ID "type", which gives the
139-
/// type of the expression (slightly simplified from C/C++ as
140-
/// \ref unsignedbv_typet, \ref signedbv_typet, \ref floatbv_typet, etc.). All type
139+
/// Many of the key descendants of \ref exprt are declared in \ref std_expr.h.
140+
/// All expressions have a named subexpression with ID "type", which gives the
141+
/// type of the expression (slightly simplified from C/C++ as \ref
142+
/// unsignedbv_typet, \ref signedbv_typet, \ref floatbv_typet, etc.). All type
141143
/// conversions are explicit with an expression with `id() == ID_typecast`
142-
/// and a \ref typecast_exprt. One key descendant of \ref exprt is \ref symbol_exprt
143-
/// which creates \ref irept instances with ID “symbol”. These are used
144-
/// to represent variables; the name of which can be found using the
144+
/// and a \ref typecast_exprt. One key descendant of \ref exprt is \ref
145+
/// symbol_exprt which creates \ref irept instances with ID “symbol”. These are
146+
/// used to represent variables; the name of which can be found using the
145147
/// `get_identifier` accessor function.
146148
///
147149
/// \ref codet inherits from \ref exprt and is defined in `std_code.h`. It

0 commit comments

Comments
 (0)