首页 文章

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

提问于
浏览
8

我正在 Build 一个关于某种库的文档,它包含一个C / C部分和一个VHDL部分,以及一些有指导性的doxygen页面 . 他们必须被置于一个独立的群体中 . 到目前为止,一切都很有效,漂亮而蓬松......

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

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

你会怎么做?

1 回答

  • 2

    我有同样的问题 - 最终我们做的是:

    • 为C代码和VHDL代码创建一个不同的目录(相应的doxygen注释文件 - 因为我们不想在任何地方使用doxygen标签垃圾代码) .

    • 为每个目录运行Doxygen(每个目录都带有自己的oprimization标签 - OPTIMIZE_OUTPUT_VHDLOPTIMIZE_OUTPUT_C

    • 组合(手动!!! - 虽然你可以为它创建一个脚本)这两个目录的输出,使主页面引用这两个目录 .

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

相关问题