From efdb2e21f45c0a87a60b47c547b68fa140a7b686 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Sat, 8 Jan 2022 07:08:25 +0000 Subject: [PATCH] Doxygen related fixes --- doc/doxygen.conf | 4 ++-- doc/doxygen.warnings.report.sh | 20 +++++++++++++++----- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/doxygen.conf b/doc/doxygen.conf index 83848f5f4..c90c3c1e9 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -2321,7 +2321,7 @@ DIA_PATH = # and usage relations if the target is undocumented or is not a class. # The default value is: YES. -HIDE_UNDOC_RELATIONS = YES +HIDE_UNDOC_RELATIONS = NO # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: @@ -2557,7 +2557,7 @@ PLANTUML_INCLUDE_PATH = # Minimum value: 0, maximum value: 10000, default value: 50. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_GRAPH_MAX_NODES = 50 +DOT_GRAPH_MAX_NODES = 70 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs # generated by dot. A depth value of 3 means that only nodes reachable from the diff --git a/doc/doxygen.warnings.report.sh b/doc/doxygen.warnings.report.sh index 06d0cb081..63772ef4c 100755 --- a/doc/doxygen.warnings.report.sh +++ b/doc/doxygen.warnings.report.sh @@ -15,7 +15,6 @@ STANDARDLOGFILE=doxygen.log WARNINGSLOGFILE=doxygen.warnings.log # Default choice: generate it LOG="$DIR/$WARNINGSLOGFILE" - # Verbose log VERBLOG="$DIR/doxygen.verbose.log" @@ -309,7 +308,10 @@ if [ $skip_doxy -eq 1 ]; then else # Modify doxygen.conf to generate all the warnings - # (We also suppress dot graphs, so shorten the run time.) + # We keep dot active to generate graphs in the documentaion + # (see for example PacketTagList) and warn about ill-formed + # graphs, but we disable all the doxygen-generated diagrams + # to shorten the run time. conf=doc/doxygen.conf cp $conf ${conf}.bak @@ -317,12 +319,20 @@ else # doxygen.warnings.report.sh: EXTRACT_ALL = no - HAVE_DOT = no - CLASS_DIAGRAMS = no WARNINGS = no + WARN_LOGFILE = doc/$WARNINGSLOGFILE SOURCE_BROWSER = no HTML_OUTPUT = html-warn - WARN_LOGFILE = doc/$WARNINGSLOGFILE + CLASS_DIAGRAMS = no + CLASS_GRAPH = no + COLLABORATION_GRAPH = no + GROUP_GRAPHS = no + INCLUDE_GRAPH = no + INCLUDED_BY_GRAPH = no + CALL_GRAPH = no + CALLER_GRAPH = no + GRAPHICAL_HIERARCHY = no + DIRECTORY_GRAPH = no EOF