From 99f6842857b26a80af2b645ed2526934f09e4288 Mon Sep 17 00:00:00 2001 From: scawful Date: Sat, 13 Apr 2024 23:09:53 -0500 Subject: [PATCH] Add graphviz dot charts to doxygen --- .github/workflows/doxy.yml | 4 ++++ Doxyfile | 14 +++++++------- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/.github/workflows/doxy.yml b/.github/workflows/doxy.yml index 13345fcd..1e2943ea 100644 --- a/.github/workflows/doxy.yml +++ b/.github/workflows/doxy.yml @@ -19,6 +19,10 @@ jobs: steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v2 + + # Installs graphviz for DOT graphs + - name: Install graphviz + run: sudo apt-get install graphviz - name: Doxygen Action uses: mattnotmitt/doxygen-action@v1.1.0 diff --git a/Doxyfile b/Doxyfile index ed2709e7..4a7e27d7 100644 --- a/Doxyfile +++ b/Doxyfile @@ -530,7 +530,7 @@ EXTRACT_ALL = NO # be included in the documentation. # The default value is: NO. -EXTRACT_PRIVATE = NO +EXTRACT_PRIVATE = YES # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. @@ -573,7 +573,7 @@ EXTRACT_LOCAL_METHODS = NO # are hidden. # The default value is: NO. -EXTRACT_ANON_NSPACES = NO +EXTRACT_ANON_NSPACES = YES # If this flag is set to YES, the name of an unnamed parameter in a declaration # will be determined by the corresponding definition. By default unnamed @@ -1210,13 +1210,13 @@ STRIP_CODE_COMMENTS = YES # entity all documented functions referencing it will be listed. # The default value is: NO. -REFERENCED_BY_RELATION = NO +REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. -REFERENCES_RELATION = NO +REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and @@ -2505,7 +2505,7 @@ HIDE_UNDOC_RELATIONS = YES # set to NO # The default value is: NO. -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of @@ -2642,7 +2642,7 @@ DOT_WRAP_THRESHOLD = 17 # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -TEMPLATE_RELATIONS = NO +TEMPLATE_RELATIONS = YES # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to # YES then doxygen will generate a graph for each documented file showing the @@ -2677,7 +2677,7 @@ INCLUDED_BY_GRAPH = YES # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -CALL_GRAPH = NO +CALL_GRAPH = YES # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller # dependency graph for every global function or class method.