Skip to content

Doxygen debugging #5053

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

Closed
wants to merge 6 commits into from
Closed

Doxygen debugging #5053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
92da8b3
Update Doxygen version
Aug 22, 2019
f631765
Update expected warnings
Aug 22, 2019
5d7afc1
Change how we check doxygen version
Aug 22, 2019
be679f7
Remove tags that are no longer needed from doxyfile
Aug 22, 2019
00a7d81
Attemtp to debug python script remotely
Aug 22, 2019
72b8e9e
more debugging
Aug 22, 2019
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
2 changes: 1 addition & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
- stage: Linter + Doxygen + non-debug Ubuntu/gcc-5 test
env:
NAME: "DOXYGEN-CHECK"
DOXYGEN_VERSION: "1.8.14"
DOXYGEN_VERSION: "1.8.16"
addons:
apt:
sources:
Expand Down
65 changes: 57 additions & 8 deletions scripts/expected_doxygen_warnings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,70 @@
/cbmc/src/solvers/miniBDD/miniBDD.cpp:402: warning: documented symbol `mini_bddt mini_bddt::operator &' was not declared or defined.
/cbmc/src/solvers/sat/satcheck_glucose.cpp:228: warning: no matching class member found for
/cbmc/src/solvers/sat/satcheck_glucose.cpp:229: warning: no matching class member found for
template <>
satcheck_glucose_baset< Glucose::Solver >::~satcheck_glucose_baset()

/cbmc/src/solvers/sat/satcheck_glucose.cpp:234: warning: no matching class member found for
/cbmc/src/solvers/sat/satcheck_glucose.cpp:235: warning: no matching class member found for
template <>
satcheck_glucose_baset< Glucose::SimpSolver >::~satcheck_glucose_baset()

/cbmc/src/solvers/sat/satcheck_minisat2.cpp:306: warning: no matching class member found for
/cbmc/src/solvers/sat/satcheck_minisat2.cpp:296: warning: no matching class member found for
template <>
satcheck_minisat2_baset< Minisat::Solver >::~satcheck_minisat2_baset()

/cbmc/src/solvers/sat/satcheck_minisat2.cpp:312: warning: no matching class member found for
/cbmc/src/solvers/sat/satcheck_minisat2.cpp:302: warning: no matching class member found for
template <>
satcheck_minisat2_baset< Minisat::SimpSolver >::~satcheck_minisat2_baset()

/cbmc/src/solvers/refinement/string_refinement.cpp:239: warning: Invalid list item found
/cbmc/doc/architectural/howto.md:260: warning: found </div> at different nesting level (6) than expected (3)
/cbmc/src/analyses/reaching_definitions.h:216: warning: end of comment block while expecting command </code>
/cbmc/jbmc/src/java_bytecode/java_bytecode_convert_method.cpp:67: warning: documented empty return type of assign_parameter_names
/cbmc/jbmc/src/java_bytecode/java_object_factory.cpp:1132: warning: documented empty return type of allocate_nondet_length_array
/cbmc/jbmc/src/java_bytecode/java_object_factory.cpp:1637: warning: documented empty return type of gen_nondet_init
/cbmc/jbmc/src/java_bytecode/java_object_factory.h:111: warning: documented empty return type of gen_nondet_init
/cbmc/src/goto-programs/link_to_library.cpp:18: warning: argument 'library' of command @param is not found in the argument list of link_to_library(goto_modelt &goto_model, message_handlert &message_handler, const std::function< void(const std::set< irep_idt > &, symbol_tablet &, message_handlert &) &
/cbmc/src/goto-programs/link_to_library.cpp:90: warning: argument 'library' of command @param is not found in the argument list of link_to_library(symbol_tablet &symbol_table, goto_functionst &goto_functions, message_handlert &message_handler, const std::function< void(const std::set< irep_idt > &, symbol_tablet &, message_handlert &) &
/cbmc/src/goto-programs/link_to_library.cpp:18: warning: argument 'library' of command @param is not found in the argument list of link_to_library(goto_modelt &goto_model, message_handlert &message_handler, const std::function< void(const std::set< irep_idt > &, symbol_tablet &, message_handlert &) &
/cbmc/src/goto-programs/link_to_library.cpp:90: warning: argument 'library' of command @param is not found in the argument list of link_to_library(symbol_tablet &symbol_table, goto_functionst &goto_functions, message_handlert &message_handler, const std::function< void(const std::set< irep_idt > &, symbol_tablet &, message_handlert &) &
/cbmc/src/goto-programs/remove_unreachable.cpp:64: warning: documented empty return type of remove_unreachable
/cbmc/src/goto-programs/remove_unreachable.h:19: warning: documented empty return type of remove_unreachable
/cbmc/src/goto-symex/slice.cpp:217: warning: documented empty return type of collect_open_variables
/cbmc/src/goto-symex/slice.cpp:229: warning: documented empty return type of slice
/cbmc/src/goto-symex/slice.h:37: warning: documented empty return type of collect_open_variables
/cbmc/src/goto-symex/slice.h:29: warning: documented empty return type of slice
/cbmc/src/solvers/strings/string_constraint_instantiation.h:27: warning: argument 'axiom' from the argument list of instantiate has multiple @param documentation sections
/cbmc/src/solvers/strings/string_constraint_instantiation.h:27: warning: argument 'str' from the argument list of instantiate has multiple @param documentation sections
/cbmc/src/solvers/strings/string_constraint_instantiation.h:27: warning: argument 'val' from the argument list of instantiate has multiple @param documentation sections
/cbmc/src/solvers/strings/string_refinement.cpp:300: warning: documented empty return type of add_equations_for_symbol_resolution
/cbmc/src/solvers/strings/string_refinement.cpp:229: warning: Invalid list item found
/cbmc/src/util/c_types_util.h:120: warning: argument 'type' from the argument list of from_c_boolean_value has multiple @param documentation sections
/cbmc/src/util/graph.h:562: warning: argument 'for_each_successor' of command @param is not found in the argument list of get_reachable(Container &set, const std::function< void(const typename Container::value_type &, const std::function< void(const typename Container::value_type &)> &) &
/cbmc/src/util/rename.cpp:27: warning: documented empty return type of get_new_name
/cbmc/src/util/rename.cpp:19: warning: documented empty return type of get_new_name
/cbmc/src/util/rename.h:26: warning: documented empty return type of get_new_name
/cbmc/src/util/rename.h:23: warning: documented empty return type of get_new_name
/cbmc/doc/architectural/howto.md:260: warning: found </div> at different nesting level (8) than expected (5)
/cbmc/doc/architectural/howto.md:261: warning: end of comment block while expecting command </div>
/cbmc/src/solvers/README.md:434: warning: Invalid list item found
/cbmc/src/solvers/README.md:631: warning: Invalid list item found
/cbmc/src/solvers/sat/cnf.h:46: warning: documented empty return type of cnft::gate_and
/cbmc/src/goto-cc/compile.h:60: warning: documented empty return type of compilet::compilet
/cbmc/src/goto-cc/compile.h:62: warning: documented empty return type of compilet::~compilet
/cbmc/src/goto-cc/compile.h:86: warning: documented empty return type of compilet::cprover_macro_arities
/cbmc/src/util/config.h:102: warning: documented empty return type of configt::ansi_ct::set_arch_spec_v850
/cbmc/src/cpp/cpp_typecheck.h:266: warning: documented empty return type of cpp_typecheckt::check_member_initializers
/cbmc/src/cpp/cpp_typecheck.h:275: warning: documented empty return type of cpp_typecheckt::full_member_initialization
/cbmc/src/goto-instrument/dot.cpp:59: warning: documented empty return type of dott::find_next
/cbmc/src/goto-instrument/dot.cpp:48: warning: documented empty return type of dott::write_dot_subgraph
/cbmc/src/goto-instrument/dot.cpp:54: warning: documented empty return type of dott::write_edge
/cbmc/src/goto-cc/goto_cc_mode.h:28: warning: documented empty return type of goto_cc_modet::usage_error
/cbmc/src/goto-symex/goto_symex.h:693: warning: argument 'state' from the argument list of goto_symext::symex_cpp_new has multiple @param documentation sections
/cbmc/src/goto-symex/goto_symex.h:693: warning: argument 'lhs' from the argument list of goto_symext::symex_cpp_new has multiple @param documentation sections
/cbmc/src/goto-symex/goto_symex.h:693: warning: argument 'code' from the argument list of goto_symext::symex_cpp_new has multiple @param documentation sections
/cbmc/jbmc/src/java_bytecode/java_bytecode_language.h:194: warning: documented empty return type of java_bytecode_languaget::methods_provided
/cbmc/src/analyses/reaching_definitions.h:216: warning: end of comment block while expecting command </code>
/cbmc/src/analyses/reaching_definitions.h:216: warning: end of comment block while expecting command </code>
/cbmc/src/analyses/reaching_definitions.cpp:647: warning: found </c> tag without matching <c>
/cbmc/src/analyses/reaching_definitions.cpp:648: warning: found </c> tag without matching <c>
/cbmc/src/analyses/reaching_definitions.cpp:649: warning: found </c> tag without matching <c>
/cbmc/src/analyses/reaching_definitions.cpp:651: warning: found </c> tag without matching <c>
/cbmc/src/analyses/reaching_definitions.h:227: warning: The following parameters of rd_range_domaint::merge(const rd_range_domaint &other, locationt from, locationt to) are not documented:
parameter 'other'
/cbmc/src/solvers/smt2/smt2_conv.h:113: warning: documented empty return type of smt2_convt::convert_rounding_mode_FPA
/cbmc/src/goto-symex/symex_slice_class.h:25: warning: documented empty return type of symex_slicet::collect_open_variables
4 changes: 4 additions & 0 deletions scripts/filter_expected_warnings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ def print_with_prefix(self, prefix):
for line in self.otherlines:
print(prefix + ' ' + line)

def print_all(self):
return 'self.firstline: ' + self.firstline + 'self.filename: ' + self.filename + 'self.warning: ' + self.warning + 'self.otherlines: ' + str(self.otherlines)

class WarningsList(object):
"""List of Doxygen warnings."""
Expand All @@ -53,6 +55,7 @@ def __init__(self, all_lines):
current = DoxygenWarning(line.strip(), filename, warning)
self.warnings_list.append(current)
elif line.startswith(' '):
print('appending ' + line.strip())
current.otherlines.append(line.strip())
else:
# Warnings are usually of the form [path:line: warning:...]
Expand All @@ -64,6 +67,7 @@ def __init__(self, all_lines):
def contains(self, warning):
"""Check if a similar warning is in this list."""
for other in self.warnings_list:
print('Comparing\n' + other.print_all() + '\nand\n' + warning.print_all())
if warning.equals_ignoring_path_and_line_number(other):
return True
return False
Expand Down
4 changes: 2 additions & 2 deletions scripts/run_doxygen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# Check doxygen version
EXPECTED_VERSION="1.8.14"
doxygen --version | grep -x $EXPECTED_VERSION > /dev/null
EXPECTED_VERSION="1.8.16"
doxygen --version | grep ^$EXPECTED_VERSION > /dev/null
if [ $? -ne 0 ]
then
echo "WARNING: Using wrong version of doxygen.\
Expand Down
15 changes: 0 additions & 15 deletions src/doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2108,12 +2108,6 @@ EXTERNAL_GROUPS = YES

EXTERNAL_PAGES = YES

# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.

PERL_PATH = /usr/bin/perl

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
Expand All @@ -2127,15 +2121,6 @@ PERL_PATH = /usr/bin/perl

CLASS_DIAGRAMS = YES

# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.

MSCGEN_PATH =

# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
Expand Down