From fa47c5c1233591a22e7a168bb5fb8d0267a7e93d Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 13 Nov 2018 10:03:25 +0000 Subject: [PATCH 1/2] Fix link in util/README.md --- scripts/expected_doxygen_warnings.txt | 1 - src/util/README.md | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/scripts/expected_doxygen_warnings.txt b/scripts/expected_doxygen_warnings.txt index 52d492ac3f0..b287066042d 100644 --- a/scripts/expected_doxygen_warnings.txt +++ b/scripts/expected_doxygen_warnings.txt @@ -27,7 +27,6 @@ /cbmc/doc/architectural/howto.md:260: warning: found at different nesting level (6) than expected (3) /cbmc/doc/architectural/howto.md:261: warning: end of comment block while expecting command /cbmc/src/solvers/README.md:4: warning: @copydetails or @copydoc target 'generate_instantiations(messaget::mstreamt &stream, const string_constraint_generatort &generator, const index_set_pairt &index_set, const string_axiomst &axioms, const std::map ¬_contain_witnesses).' not found -/cbmc/src/util/README.md:245: warning: unable to resolve reference to `ansi_ct' for \ref command /cbmc/src/cbmc/bmc.cpp:473: warning: argument 'message' of command @param is not found in the argument list of bmct::do_language_agnostic_bmc(const path_strategy_choosert &path_strategy_chooser, const optionst &opts, abstract_goto_modelt &model, ui_message_handlert &ui, std::function< void(bmct &, const symbol_tablet &)> driver_configure_bmc=nullptr, std::function< bool(void)> callback_after_symex=nullptr) /cbmc/src/cbmc/bmc.h:124: warning: The following parameters of bmct::do_language_agnostic_bmc(const path_strategy_choosert &path_strategy_chooser, const optionst &opts, abstract_goto_modelt &model, ui_message_handlert &ui, std::function< void(bmct &, const symbol_tablet &)> driver_configure_bmc=nullptr, std::function< bool(void)> callback_after_symex=nullptr) are not documented: parameter 'path_strategy_chooser' diff --git a/src/util/README.md b/src/util/README.md index 89b4850e4b7..e23fc6f46bd 100644 --- a/src/util/README.md +++ b/src/util/README.md @@ -241,8 +241,8 @@ Symbols have: * A mode, which indicates the source language frontend responsible for creating them. This is mainly used in pretty-printing the symbol table, to indicate the appropriate language frontend to use rendering the symbol's value and/or - type. For example, mode == ID_C == "C" indicates that \ref ansi_ct, the C - front-end, should be used to pretty-print, which in turn delegates to + type. For example, mode == ID_C == "C" indicates that \ref ansi_c_languaget, + the C front-end, should be used to pretty-print, which in turn delegates to \ref expr2ct. * A base-name and pretty-name, which are a short and user-friendly version of the symbol's definitive name respectively. From 30f735bab46690a455e26e62a9de36dae226cf65 Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 13 Nov 2018 10:10:07 +0000 Subject: [PATCH 2/2] Correct parameter comments in json_irep.cpp --- scripts/expected_doxygen_warnings.txt | 6 ------ src/util/json_irep.cpp | 4 ++-- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/scripts/expected_doxygen_warnings.txt b/scripts/expected_doxygen_warnings.txt index b287066042d..c2b0a37415c 100644 --- a/scripts/expected_doxygen_warnings.txt +++ b/scripts/expected_doxygen_warnings.txt @@ -121,12 +121,6 @@ parameter 'function_id' /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: parameter 'function_id' -/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) -/cbmc/src/util/json_irep.h:23: warning: The following parameters of json_irept::json_irept(bool _include_comments) are not documented: - parameter '_include_comments' -/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 -/cbmc/src/util/json_irep.h:25: warning: The following parameters of json_irept::convert_from_json(const jsont &in) const are not documented: - parameter 'in' /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) /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: parameter 'stubs_enabled' diff --git a/src/util/json_irep.cpp b/src/util/json_irep.cpp index 375e06eb82a..7a1e3b5e9ba 100644 --- a/src/util/json_irep.cpp +++ b/src/util/json_irep.cpp @@ -19,7 +19,7 @@ Author: Thomas Kiley, thomas.kiley@diffblue.com /// To convert to JSON from an irep structure by recursively generating JSON /// for the different sub trees. -/// \param include_comments: when writing JSON, should the comments +/// \param _include_comments: when writing JSON, should the comments /// sub tree be included. json_irept::json_irept(bool _include_comments): include_comments(_include_comments) @@ -95,7 +95,7 @@ void json_irept::convert_named_sub_tree( } /// Deserialize a JSON irep representation. -/// \param input: json object to convert +/// \param in: json object to convert /// \return result - irep equivalent of input irept json_irept::convert_from_json(const jsont &in) const {