Skip to content

Fix Doxygen warnings in files in /util folder #3381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2018
Merged

Fix Doxygen warnings in files in /util folder #3381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa47c5c
Fix link in util/README.md
Nov 13, 2018
30f735b
Correct parameter comments in json_irep.cpp
Nov 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions scripts/expected_doxygen_warnings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/cbmc/doc/architectural/howto.md:260: warning: found </div> at different nesting level (6) than expected (3)
/cbmc/doc/architectural/howto.md:261: warning: end of comment block while expecting command </div>
/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<string_not_contains_constraintt, symbol_exprt> &not_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'
Expand Down Expand Up @@ -122,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'
Expand Down
4 changes: 2 additions & 2 deletions src/util/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/util/json_irep.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Author: Thomas Kiley, [email protected]

/// 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename this parameter to include_comments instead.

/// sub tree be included.
json_irept::json_irept(bool _include_comments):
include_comments(_include_comments)
Expand Down Expand Up @@ -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
{
Expand Down