From 053b5914b6dd1d16adb78d5ebf8b6b8eaaabd6d7 Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 2 Oct 2018 08:34:25 +0100 Subject: [PATCH 1/3] Fix warnings about not-enabled options Doxygen generates warnings about CLANG_ options which were not enabled at compile time. Since these options were being set to their default values, there is no need to set them, so they have been commented out. --- src/doxyfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/doxyfile b/src/doxyfile index 59985638e2a..91077af1551 100644 --- a/src/doxyfile +++ b/src/doxyfile @@ -1020,7 +1020,7 @@ VERBATIM_HEADERS = YES # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. -CLANG_ASSISTED_PARSING = NO +#CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that @@ -1028,7 +1028,7 @@ CLANG_ASSISTED_PARSING = NO # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. -CLANG_OPTIONS = +#CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index From 66d271c06a14d3fb63053f49379f8c6c04e8643a Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 2 Oct 2018 08:53:05 +0100 Subject: [PATCH 2/3] Fix doxygen syntax by adding subsection names --- src/goto-symex/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/goto-symex/README.md b/src/goto-symex/README.md index f93d32f7ff5..80fd4c18cc8 100644 --- a/src/goto-symex/README.md +++ b/src/goto-symex/README.md @@ -81,7 +81,7 @@ the instruction type, i.e. goto_symext::symex_function_call() if the current instruction is a function call, goto_symext::symex_goto() if the current instruction is a goto, etc. -\subsection Loop and recursion unwinding +\subsection symex-loop-and-recursion-unwinding Loop and recursion unwinding Each backwards goto and recursive call has a separate counter (handled by \ref cbmc or another driver program, see the `--unwind` and @@ -91,7 +91,7 @@ be handled completely (assuming the unwinding limit is sufficient). When an unwind or recursion limit is reached, an assertion can be added to explicitly show when analysis is incomplete. -\subsection \ref goto_symext::clean_expr +\subsection goto-symext-clean-expr goto_symext::clean_expr Before any expression is incorporated into the output equation set it is passed through \ref goto_symext::clean_expr and thus \ref goto_symext::dereference, From 6688c5a2ebd10585c1e6ccfc5ada789eaaa110ee Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 2 Oct 2018 14:13:23 +0100 Subject: [PATCH 3/3] Remove redundant doxygen file header The doxygen \file tag was included twice, as well as the brief file description, author and date. (And the second time, it had an incorrect filename.) This commit deletes the second \file comment block. --- src/goto-programs/goto_trace.h | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/goto-programs/goto_trace.h b/src/goto-programs/goto_trace.h index 64d8001cf8d..a462969f30f 100644 --- a/src/goto-programs/goto_trace.h +++ b/src/goto-programs/goto_trace.h @@ -14,13 +14,6 @@ Date: July 2005 #ifndef CPROVER_GOTO_PROGRAMS_GOTO_TRACE_H #define CPROVER_GOTO_PROGRAMS_GOTO_TRACE_H -/*! \file goto-symex/goto_trace.h - * \brief Traces through goto programs - * - * \author Daniel Kroening - * \date Sun Jul 31 21:54:44 BST 2011 -*/ - #include #include