Doxygen：具有C ++和VHDL的项目的无缝文档 [英] Doxygen: Seamless documentation for project with C++ and VHDL

问题描述

我正在建立有关某种库的文档，该库由C / C ++部分和VHDL部分以及一些仅用于指导性的Doxygen页组成。必须将它们放在一个独立的组中。到目前为止，一切都可以正常工作，而且很好而且蓬松...

I'm setting up a documentation about some sort of Library which consists of a C/C++ part and a VHDL part, plus some instructive doxygen-only pages. They have to be put into one self-contained group. Everything works so far, nice and fluffy...

但是如果我想通过使用 OPTIMIZE_OUTPUT_VHDL优化vhdl-子目录中的输出怎么办？是，并同时使用 OPTIMIZE_OUTPUT_C = YES 优化c子目录的输出？

But what if I want to optimize the output in the vhdl-subdirectory by using OPTIMIZE_OUTPUT_VHDL = YES and optimize the output of the c-subdirectory by using OPTIMIZE_OUTPUT_C = YES at the same time?

据我了解，使用 doxygen-tags 并不是最佳选择就我而言，由于它在每个子目录中引入了新的doxyfile.conf文件，并且在每个子目录中都独立运行了doxygen。因此，这样做后，我无法再将两个部分（c + vhdl）放在同一组的不同子组中，并且这两个部分之间也无法建立链接。另外，整个模块应该是独立的，以便包含在更大的文档中，而无需在此解决方案中涉及特殊的构建结构。

As far as I understand, using doxygen-tags is not optimal in my case, since it introduces new doxyfile.conf-files in each subdirectory, with independent runs of doxygen in each subdirectory. So, doing this I can't put both parts (c+vhdl) in different subgroups of the same group anymore, and links between the two parts are not possible. Also, the whole module should be "selfcontained", to be includable into bigger documentations, without the special build-structure involved in this solution...

您会做什么？

推荐答案

我遇到了同样的问题-最终我们要做的是：

I had the same problem - eventually what we did is:

1. 为C代码和VHDL代码创建一个不同的目录（以及相应的doxygen注释文件-因为我们不想到处都使用doxygen标签对代码进行垃圾邮件）。


2. 为每个目录运行Doxygen（每个目录都有其自己的优化标签- OPTIMIZE_OUTPUT_VHDL 或 OPTIMIZE_OUTPUT_C ）


3. 组合（手动！-尽管您可以为其创建脚本）这两个目录的输出，以便主页可以引用这两个目录。

1. Create a different directory for C code and VHDL code (+ respective doxygen comment files - as we didn't want to spam the code with doxygen tags everywhere).
2. Run Doxygen for each of these directories (each with it's own oprimization tag - OPTIMIZE_OUTPUT_VHDL or OPTIMIZE_OUTPUT_C )
3. Combine (manually!!!- though you can create a script for it) the output of these two directories such that the main page would reference the two directories.

最终我决定缩短生成文档的时间，而我只是忽略了优化标记...

Eventually I decided to shorten the time it takes to generate the documentation, and I just ignore the optimization tags...

这篇关于Doxygen：具有C ++和VHDL的项目的无缝文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！