Skip to content

Commit 16c1d0f

Browse files
Add more doxygen to languaget
1 parent 0ea332a commit 16c1d0f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/langapi/language.h

+21
Original file line numberDiff line numberDiff line change
@@ -114,21 +114,42 @@ class languaget:public messaget
114114

115115
// conversion of expressions
116116

117+
/// Formats the given expression in a language-specific way
118+
/// \param expr: the expression to format
119+
/// \param code: the formatted expression
120+
/// \param ns: a namespace
121+
/// \return false if conversion succeeds
117122
virtual bool from_expr(
118123
const exprt &expr,
119124
std::string &code,
120125
const namespacet &ns);
121126

127+
/// Formats the given type in a language-specific way
128+
/// \param type: the type to format
129+
/// \param code: the formatted type
130+
/// \param ns: a namespace
131+
/// \return false if conversion succeeds
122132
virtual bool from_type(
123133
const typet &type,
124134
std::string &code,
125135
const namespacet &ns);
126136

137+
/// Encodes the given type in a language-specific way
138+
/// \param type: the type to encode
139+
/// \param name: the encoded type
140+
/// \param ns: a namespace
141+
/// \return false if the conversion succeeds
127142
virtual bool type_to_name(
128143
const typet &type,
129144
std::string &name,
130145
const namespacet &ns);
131146

147+
/// Parses the given string into an expression
148+
/// \param code: the string to parse
149+
/// \param module: prefix to be used for identifiers
150+
/// \param expr: the parsed expression
151+
/// \param ns: a namespace
152+
/// \return false if the conversion succeeds
132153
virtual bool to_expr(
133154
const std::string &code,
134155
const std::string &module,

0 commit comments

Comments
 (0)