Doxygen:使用 C++ 进行项目的无缝文档和VHDL

发布于 2024-10-18 21:40:25 字数 542 浏览 0 评论 0原文

我正在建立一个关于某种库的文档,该库由 C/C++ 部分和 VHDL 部分以及一些仅包含 doxygen 的指导性页面组成。他们必须被放入一个独立的组中。到目前为止,一切正常,漂亮又蓬松...

但是,如果我想使用 OPTIMIZE_OUTPUT_VHDL = YES 优化 vhdl 子目录中的输出并使用 OPTIMIZE_OUTPUT_VHDL = YES 优化 c 子目录的输出,该怎么办>同时OPTIMIZE_OUTPUT_C = YES?

据我了解,使用 doxygen-tags 在我的情况下并不是最佳选择,因为它在每个子目录中引入了新的 doxyfile.conf 文件,并且在每个子目录中独立运行 doxygen。因此,这样做我不能再将两个部分(c+vhdl)放在同一组的不同子组中,并且两个部分之间的链接是不可能的。另外,整个模块应该是“独立的”,可以包含在更大的文档中,而无需此解决方案中涉及的特殊构建结构......

您会做什么?

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...

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?

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...

What would you do?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

神经大条 2024-10-25 21:40:25

我遇到了同样的问题 - 最终我们所做的是:

  1. 为 C 代码和 VHDL 代码创建一个不同的目录(+各自的 doxygen 注释文件 - 因为我们不想到处都用 doxygen 标签发送垃圾邮件)。
  2. 为每个目录运行 Doxygen(每个目录都有自己的 oprimization 标记 - OPTIMIZE_OUTPUT_VHDLOPTIMIZE_OUTPUT_C
  3. 合并(手动!!!-尽管您可以为其创建脚本)这两个目录的输出,以便主页将引用这两个目录。

最终我决定缩短生成文档所需的时间,我只是忽略优化标签......

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

  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...

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文