Skip to content

Commit 3c57c6f

Browse files
author
Joel Allred
committed
Doc corrections
1 parent 86f3f46 commit 3c57c6f

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

src/util/std_expr.h

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ inline const transt &to_trans_expr(const exprt &expr)
5252
return static_cast<const transt &>(expr);
5353
}
5454

55-
/// \copydoc to_trans(const exprt &)
55+
/// \copydoc to_trans_expr(const exprt &)
5656
inline transt &to_trans_expr(exprt &expr)
5757
{
5858
PRECONDITION(expr.id()==ID_trans);
@@ -114,7 +114,8 @@ class symbol_exprt:public exprt
114114
}
115115
};
116116

117-
/// Expression to hold a symbol (variable)
117+
/// Expression to hold a symbol (variable) with extra ccessors to
118+
/// ID_c_static_lifetime and ID_C_thread_local
118119
class decorated_symbol_exprt:public symbol_exprt
119120
{
120121
public:
@@ -516,7 +517,7 @@ inline void validate_expr(const bswap_exprt &value)
516517
}
517518

518519
/// \brief A generic base class for expressions that are predicates,
519-
/// i.e., boolean-typed.
520+
/// i.e., Boolean-typed.
520521
class predicate_exprt:public exprt
521522
{
522523
public:
@@ -546,7 +547,7 @@ class predicate_exprt:public exprt
546547
};
547548

548549
/// \brief A generic base class for expressions that are predicates,
549-
/// i.e., boolean-typed, and that take exactly one argument.
550+
/// i.e., Boolean-typed, and that take exactly one argument.
550551
class unary_predicate_exprt:public unary_exprt
551552
{
552553
public:
@@ -571,6 +572,7 @@ class unary_predicate_exprt:public unary_exprt
571572
};
572573

573574
/// \brief sign of an expression
575+
/// Predicate is true if \a _op is negative, false otherwise.
574576
class sign_exprt:public unary_predicate_exprt
575577
{
576578
public:
@@ -659,7 +661,7 @@ template<> inline bool can_cast_expr<binary_exprt>(const exprt &base)
659661

660662

661663
/// \brief A generic base class for expressions that are predicates,
662-
/// i.e., boolean-typed, and that take exactly two arguments.
664+
/// i.e., Boolean-typed, and that take exactly two arguments.
663665
class binary_predicate_exprt:public binary_exprt
664666
{
665667
public:
@@ -1025,7 +1027,7 @@ inline void validate_expr(const div_exprt &value)
10251027
}
10261028

10271029

1028-
/// \brief binary modulo
1030+
/// \brief modulo
10291031
class mod_exprt:public binary_exprt
10301032
{
10311033
public:
@@ -2038,7 +2040,7 @@ inline void validate_expr(const floatbv_typecast_exprt &value)
20382040
}
20392041

20402042

2041-
/// \brief boolean AND
2043+
/// \brief Boolean AND
20422044
class and_exprt:public multi_ary_exprt
20432045
{
20442046
public:
@@ -2115,7 +2117,7 @@ template<> inline bool can_cast_expr<and_exprt>(const exprt &base)
21152117
// }
21162118

21172119

2118-
/// \brief boolean implication
2120+
/// \brief Boolean implication
21192121
class implies_exprt:public binary_exprt
21202122
{
21212123
public:
@@ -2161,7 +2163,7 @@ inline void validate_expr(const implies_exprt &value)
21612163
}
21622164

21632165

2164-
/// \brief boolean OR
2166+
/// \brief Boolean OR
21652167
class or_exprt:public multi_ary_exprt
21662168
{
21672169
public:
@@ -4085,7 +4087,7 @@ template<> inline bool can_cast_expr<constant_exprt>(const exprt &base)
40854087
}
40864088

40874089

4088-
/// \brief The boolean constant true
4090+
/// \brief The Boolean constant true
40894091
class true_exprt:public constant_exprt
40904092
{
40914093
public:
@@ -4095,7 +4097,7 @@ class true_exprt:public constant_exprt
40954097
}
40964098
};
40974099

4098-
/// \brief The boolean constant false
4100+
/// \brief The Boolean constant false
40994101
class false_exprt:public constant_exprt
41004102
{
41014103
public:

0 commit comments

Comments
 (0)