mosra
commented
3 years ago Hi, thanks for your interest in this project!
The namespaces/classes/files list is empty in case there's no explicit documentation for these. This is because the Doxygen XML output includes absolutely everything and there's no other reliable way to know what's wanted and what not. Please check the relevant section in the docs to see what you can do to fix that.
I cloned the project and did just a minimal change to document the top-level directory, file and namespace:
diff --git a/taskflow/taskflow.hpp b/taskflow/taskflow.hpp
index 784a5719..b77189ba 100644
--- a/taskflow/taskflow.hpp
+++ b/taskflow/taskflow.hpp
@@ -4,8 +4,13 @@
#include "core/algorithm/for_each.hpp"
#include "core/algorithm/reduce.hpp"
+/** @dir taskflow
+@brief Root taskflow include dir
+*/
+
/**
@file taskflow/taskflow.hpp
+@brief Main taskflow include file
*/
// TF_VERSION % 100 is the patch level
@@ -19,6 +24,9 @@
#define TF_MINOR_VERSION TF_VERSION/100%1000
#define TF_PATCH_VERSION TF_VERSION%100
+/**
+@brief The taskflow namespace
+*/
namespace tf {
/**and the class list at least now looks like this. I see some of the headers already have the @file doc, so it's just @brief missing :)
For the "misaligned list" issue, it's because the theme by default indents first line of each paragraph (if you browse the generated pages with more prose, you'll see that clearer). There are two options -- either convert the paragraph to a list (which you can then make unstyled again using a CSS class):
Or (because this aspect of the theme is apparently very controversial), you can patch the CSS here to not do an indent and then regenerate the compiled styles as described here:
--paragraph-indent: 0;Oh, and I saw you're using Graphviz diagrams throughout the docs -- m.css has builtin support for those and it can embed their SVG in a way that matches the page style. I made a few changes, mainly using @dotfile instead of @image, telling Doxygen to use a font that matches the theme and used builtin m.css style classes instead of hardcoded colors. (Relevant docs.) This is the result:
diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile
index f0a5d014..06e718a2 100644
--- a/doxygen/Doxyfile
+++ b/doxygen/Doxyfile
@@ -2290,14 +2290,14 @@ DOT_NUM_THREADS = 0
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTNAME = Helvetica
+DOT_FONTNAME = Source Sans Pro
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTSIZE = 10
+DOT_FONTSIZE = 16
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
@@ -2455,7 +2455,7 @@ DOT_PATH =
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
-DOTFILE_DIRS =
+DOTFILE_DIRS = ./
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
diff --git a/doxygen/cookbook/Chapter4.dox b/doxygen/cookbook/Chapter4.dox
index bca375cd..068d630e 100644
--- a/doxygen/cookbook/Chapter4.dox
+++ b/doxygen/cookbook/Chapter4.dox
@@ -31,7 +31,7 @@ The index is defined with respect to the order of its successo
r construction.
16: executor.run(taskflow).wait();
@endcode
-@image html images/conditional-tasking-1.svg width=45%
+@dotfile images/conditional-tasking-1.dot
The example above implements a simple yet commonly used feedback loop through
a condition task (line 7-10) that returns
@@ -83,7 +83,7 @@ Debrief:
@li Line 30 creates a condition task that goes to G and H on return 0 and 1, re
spectively
@li Line 31 creates a condition task that loops back to itself on return 0, and
proceeds to L on return 1
-@image html images/conditional-tasking-2.svg width=100%
+@dotfile images/conditional-tasking-2.dot
You can use condition tasks to create cycles as long as the graph does not intr
oduce task race during execution. However, cycles are not allowed in non-conditi
on tasks.
diff --git a/doxygen/images/conditional-tasking-1.dot b/doxygen/images/condition
al-tasking-1.dot
index 32e761ec..ca0515f1 100644
--- a/doxygen/images/conditional-tasking-1.dot
+++ b/doxygen/images/conditional-tasking-1.dot
@@ -1,6 +1,6 @@
digraph Taskflow {
rankdir="LR"
- cond[label="cond" shape=diamond color=black fillcolor=aquamarine style=fille
d];
+ cond[label="cond" shape=diamond class="m-success" style=filled];
init->cond;
cond->cond[style=dashed label="0"];
cond->stop[style=dashed label="1"];Not sure how/if this fits into your pipeline, just so you're aware this exists. It also doesn't work well for dot files containing subgraph, if you'd want to use this feature, I'd need to look into fixing that. Shouldn't be hard tho.
tsung-wei-huang
Hi, I tried using m.css to regenerate my doxygen to your format but the output doesn't seem to have correct links for Namespaces, Classes, and Files on the navbar. When I click on Classes, it shows nothing.
I created a Doxygen-mcss with the following content:
and use the command based on your tutorial:
./doxygen.py path/to/this/Doxyfile-mcssMy Doxygen is 1.8.14
Also, when I click on a link at the Pages, the subitems don't seem to align correctly: