Skip to content

Commit 657c1a6

Browse files
author
Thomas Kiley
committed
Fix the documentation for convert_default
Consolidate the documentation - deleting the duplicated doxygen that was attached to the implementation as well as the declaration
1 parent a8c5f57 commit 657c1a6

File tree

2 files changed

+2
-10
lines changed

2 files changed

+2
-10
lines changed

src/goto-programs/json_goto_trace.cpp

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -276,16 +276,6 @@ void convert_return(
276276
json_call_return["sourceLocation"] = location;
277277
}
278278

279-
/// Convert all other types of steps not already handled
280-
/// by the other conversion functions.
281-
/// \param [out] json_location_only: The JSON object that
282-
/// will contain the information about the step
283-
/// after this function has run.
284-
/// \param conversion_dependencies: A structure
285-
/// that contains information the conversion function
286-
/// needs.
287-
/// \param step_kind: The kind of default step we are printing.
288-
/// See \ref default_step_kind
289279
void convert_default(
290280
json_objectt &json_location_only,
291281
const conversion_dependenciest &conversion_dependencies,

src/goto-programs/json_goto_trace.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ void convert_return(
9999
/// \param conversion_dependencies: A structure
100100
/// that contains information the conversion function
101101
/// needs.
102+
/// \param step_kind: The kind of default step we are printing.
103+
/// See \ref default_step_kind
102104
void convert_default(
103105
json_objectt &json_location_only,
104106
const conversion_dependenciest &conversion_dependencies,

0 commit comments

Comments
 (0)