Skip to content

Commit 11088d3

Browse files
Add more doxygen to languaget
1 parent 4d3cca3 commit 11088d3

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

src/langapi/language.h

+33
Original file line numberDiff line numberDiff line change
@@ -115,27 +115,60 @@ class languaget:public messaget
115115

116116
// conversion of expressions
117117

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

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

138+
/// Formats the given expression as a JSON object in a language-specific way
139+
/// \param expr: the expression to format
140+
/// \param ns: a namespace
141+
/// \return the JSON object
128142
virtual json_objectt json(const exprt &, const namespacet &);
129143

144+
/// Formats the given type as a JSON object in a language-specific way
145+
/// \param type: the type to format
146+
/// \param ns: a namespace
147+
/// \return the JSON object
130148
virtual json_objectt json(const typet &, const namespacet &);
131149

150+
/// Formats the given source location as a JSON object
151+
/// in a language-specific way
152+
/// \param source_location: the source location to format
153+
/// \return the JSON object
132154
virtual json_objectt json(const source_locationt &);
133155

156+
/// Encodes the given type in a language-specific way
157+
/// \param type: the type to encode
158+
/// \param name: the encoded type
159+
/// \param ns: a namespace
160+
/// \return false if the conversion succeeds
134161
virtual bool type_to_name(
135162
const typet &type,
136163
std::string &name,
137164
const namespacet &ns);
138165

166+
/// Parses the given string into an expression
167+
/// \param code: the string to parse
168+
/// \param module: prefix to be used for identifiers
169+
/// \param expr: the parsed expression
170+
/// \param ns: a namespace
171+
/// \return false if the conversion succeeds
139172
virtual bool to_expr(
140173
const std::string &code,
141174
const std::string &module,

0 commit comments

Comments
 (0)