Skip to content

Commit b88944d

Browse files
Fix documentation style of existing documentation
Doxygen comments should start with ///
1 parent f1d9a2f commit b88944d

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

src/goto-programs/goto_trace.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,7 @@ class goto_trace_stept
143143
// for function call
144144
std::vector<exprt> function_arguments;
145145

146-
/*! \brief outputs the trace step in ASCII to a given stream
147-
*/
146+
/// Outputs the trace step in ASCII to a given stream
148147
void output(
149148
const class namespacet &ns,
150149
std::ostream &out) const;
@@ -179,8 +178,7 @@ class goto_tracet
179178
steps.clear();
180179
}
181180

182-
/*! \brief outputs the trace in ASCII to a given stream
183-
*/
181+
/// Outputs the trace in ASCII to a given stream
184182
void output(
185183
const class namespacet &ns,
186184
std::ostream &out) const;
@@ -196,8 +194,8 @@ class goto_tracet
196194
steps.push_back(step);
197195
}
198196

199-
// retrieves the final step in the trace for manipulation
200-
// (used to fill a trace from code, hence non-const)
197+
/// Retrieves the final step in the trace for manipulation
198+
/// (used to fill a trace from code, hence non-const)
201199
goto_trace_stept &get_last_step()
202200
{
203201
return steps.back();

0 commit comments

Comments
 (0)