Doxygen:C ++项目中的多个\ mainpage块

时间:2010-06-25 08:26:47

标签: c++ doxygen

在两种情况下,我无法确定doxygen对\mainpage部分的行为:

  1. 如果您没有指定\mainpage部分,那么它是否会使用任何其他页面,如果是,那么这是如何选择的?
  2. 如果两个文件都指定了\mainpage部分,该怎么办?

1 个答案:

答案 0 :(得分:9)

\mainpage命令指定用于自定义索引页面的内容,因此如果您缺少一个,它只是一个带有正常Doxygen页眉和页脚的空白页面。

我认为对于拥有多个\mainpage命令最安全的说法是,它是 undefined ,在经典意义上会产生不可预测的结果,具体取决于版本和平台。同样地,当我意外地创建了多个具有相同页面名称的\page命令时,我得到了奇怪的结果。

进一步思考

answering another Doxygen question提示,记住你可以让Doxygen遵守预处理程序指令,这样你就可以让#if条件保护多个mainpage指令并在同一代码库上运行不同的配置文件,其中配置文件定义一个几个旗帜值。

我已经使用此从不同角度生成文档方法来发布相同参考的MacintoshWindows-oriented版本。