Doxygen Markdown:如何包含和呈现 .dot GraphViz 文件
Doxygen Markdown : How to include and render a .dot GraphViz file
我有 Graphviz 文件 "foo.dot",其中包含我想在 markdown "bar.md" 中使用 doxygen 渲染的图表。
知道:
- Doxygen 支持 markdown(我解决了单独的 markdown .md 文件的情况);
- Doxygen 支持 Graphviz .dot 文件以及源中的指令(.cpp 或其他)。
是否可以在 doxygen 呈现的 markdown 中执行相同的操作(例如不求助于 gravizo 等远程服务)?
我想这样做是为了受益于 .dot 图和 markdown 以及 doxygen 的资产。
我认为你必须设置
HAVE_DOT = YES
在你的 doxygen 配置文件中。
请参阅标准 doxyfile 的评论:
# 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:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
此外,您还可以查看 DOTFILE_DIRS
值:
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
如果您正确设置了这些值,我认为您发布的 \dotfile myDiagram.dot
命令应该有效。
这也支持*.gv类型的文件,它与*.dot文件基本相同(内容没有区别)但如果你安装了MS Word并且*.dot文件类型可能更容易处理与 Word 模板文件关联。
我有 Graphviz 文件 "foo.dot",其中包含我想在 markdown "bar.md" 中使用 doxygen 渲染的图表。
知道:
- Doxygen 支持 markdown(我解决了单独的 markdown .md 文件的情况);
- Doxygen 支持 Graphviz .dot 文件以及源中的指令(.cpp 或其他)。
是否可以在 doxygen 呈现的 markdown 中执行相同的操作(例如不求助于 gravizo 等远程服务)?
我想这样做是为了受益于 .dot 图和 markdown 以及 doxygen 的资产。
我认为你必须设置
HAVE_DOT = YES
在你的 doxygen 配置文件中。 请参阅标准 doxyfile 的评论:
# 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:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
此外,您还可以查看 DOTFILE_DIRS
值:
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
如果您正确设置了这些值,我认为您发布的 \dotfile myDiagram.dot
命令应该有效。
这也支持*.gv类型的文件,它与*.dot文件基本相同(内容没有区别)但如果你安装了MS Word并且*.dot文件类型可能更容易处理与 Word 模板文件关联。