Skip to content

Commit 30f735b

Browse files
author
John Nonweiler
committed
Correct parameter comments in json_irep.cpp
1 parent fa47c5c commit 30f735b

File tree

2 files changed

+2
-8
lines changed

2 files changed

+2
-8
lines changed

scripts/expected_doxygen_warnings.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,6 @@
121121
parameter 'function_id'
122122
/cbmc/jbmc/src/java_bytecode/java_string_library_preprocess.h:160: warning: The following parameters of java_string_library_preprocesst::make_string_format_code(const java_method_typet &type, const source_locationt &loc, const irep_idt &function_id, symbol_table_baset &symbol_table) are not documented:
123123
parameter 'function_id'
124-
/cbmc/src/util/json_irep.cpp:21: warning: argument 'include_comments' of command @param is not found in the argument list of json_irept::json_irept(bool _include_comments)
125-
/cbmc/src/util/json_irep.h:23: warning: The following parameters of json_irept::json_irept(bool _include_comments) are not documented:
126-
parameter '_include_comments'
127-
/cbmc/src/util/json_irep.cpp:98: warning: argument 'input' of command @param is not found in the argument list of json_irept::convert_from_json(const jsont &in) const
128-
/cbmc/src/util/json_irep.h:25: warning: The following parameters of json_irept::convert_from_json(const jsont &in) const are not documented:
129-
parameter 'in'
130124
/cbmc/src/langapi/language_file.cpp:51: warning: argument 'should_generate_stubs' of command @param is not found in the argument list of language_filest::set_should_generate_opaque_method_stubs(bool stubs_enabled)
131125
/cbmc/src/langapi/language_file.h:104: warning: The following parameters of language_filest::set_should_generate_opaque_method_stubs(bool stubs_enabled) are not documented:
132126
parameter 'stubs_enabled'

src/util/json_irep.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Author: Thomas Kiley, [email protected]
1919

2020
/// To convert to JSON from an irep structure by recursively generating JSON
2121
/// for the different sub trees.
22-
/// \param include_comments: when writing JSON, should the comments
22+
/// \param _include_comments: when writing JSON, should the comments
2323
/// sub tree be included.
2424
json_irept::json_irept(bool _include_comments):
2525
include_comments(_include_comments)
@@ -95,7 +95,7 @@ void json_irept::convert_named_sub_tree(
9595
}
9696

9797
/// Deserialize a JSON irep representation.
98-
/// \param input: json object to convert
98+
/// \param in: json object to convert
9999
/// \return result - irep equivalent of input
100100
irept json_irept::convert_from_json(const jsont &in) const
101101
{

0 commit comments

Comments
 (0)