【问题标题】:Doxygen: Seamless documentation for project with C++ and VHDLDoxygen:使用 C++ 和 VHDL 进行项目的无缝文档
【发布时间】:2011-02-24 09:35:14
【问题描述】:

我正在建立一个关于某种库的文档,它由一个 C/C++ 部分和一个 VHDL 部分组成,加上一些指导性的 doxygen-only 页面。他们必须被放入一个独立的组中。到目前为止一切正常,又好又蓬松...

但是如果我想同时使用OPTIMIZE_OUTPUT_VHDL = YES优化vhdl-子目录的输出,同时使用OPTIMIZE_OUTPUT_C = YES优化c-子目录的输出呢?

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

你会怎么做?

【问题讨论】:

    标签: c++ doxygen vhdl


    【解决方案1】:

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

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

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

    【讨论】:

      猜你喜欢
      • 2020-07-23
      • 2014-10-24
      • 2020-10-03
      • 2012-11-11
      • 1970-01-01
      • 1970-01-01
      • 2014-02-12
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多