如何在多个文件中拆分doxygen @mainpage文档

Question

我想在@mainpage部分中包含多个.txt文件（或.md文件，用markdown编写）。

但是，我在每个文本文件中都有一个单独的章节。怎么能阻止这种情况？

Answer 1

我在这里寻找同一问题的答案，因为似乎没有人解决它，我自己寻找解决方案。

我找到了这个......

http://www.doxygen.nl/manual/preprocessing.html

  

用作doxygen输入的源文件可以解析   doxygen的内置C预处理器。默认情况下doxygen只做   部分预处理。

所以要拆分页面，例如几个文件的主页面，看起来像解决方案是在markdown文件上完全启用C预处理器，并使用

  

#include file1.md

     

#include file2.md

等包含各种降价文件。

我们想要做的是使用Doxygen＆＃39>

  

\ include file1.md

     

\ include file2.md

但不幸的是Doxygen第二次猜到我们想要包含的文件是代码文件。 就像Doxygen有一个\ htmlinclude来节省你写两行

一样

  

\ htmlonly

     

\ endhtmlonly

指定内容是HTML，\ include命令实际上是一种\ codeinclude，用于保存您指定包含的内容是软件。

我个人更喜欢输入额外的两行来指定我所包含文件的性质：代码，HTML，降价或其他，并且有一个通用的include命令。但他们说永远不会在口中看到礼物马，这基本上意味着你不能与自由软件争论！

Answer 2

你可以这样做：

@mainpage
This is your live and it isn't getting any better then this! This is your life and it's ending one minute at a time!
<a href="/mnt/home/USER/vis/Doxyfile">Doxyfile</a> @n
<a href="/mnt/home/USER/vis/DoxygenLayout.xml">DoxygenLayout.xml</a><br>

在每次引用后放置一个@n, \n, <br>来打破行，否则所有内容都将放在一行中。

---

您还可以定义一个组，将其他参考添加到该组：
@mainpage
@ref test

首先，您将@ref标记放入主页。然后你定义一个组，例如

@defgroup test
@{
<a href="/mnt/home/USER/vis/Doxyfile">Doxyfile</a>
@}

现在，您开始使用以下链接将链接从其他文件添加到该组：

@addtogroup
<a href="/mnt/home/USER/GROUP/Doxyfile">AnotherDoxyfile</a>

但是，这只会显示主页中的组名，而不是所有文件。

---

我假设你想要的是，把一个锚放在一个文件中：

@anchor ANCHORTEST
@{
<a href="/mnt/home/stud-dral1012/vis/Doxyfile">TESTFILE</a>
@}

然后将该锚点放在您的主页中：

@mainpage
@ref ANCHORTEST @n