1

I have a simple doxygen project consisting of Doxyfile and a configuration file, project.txt. In the project.txt file, I have some manually written documentation that uses cross-references to auto generated documentation from my code, and it all works fine.

I am trying to break down my project into subsections, like:

project.txt
disclaimer.txt
readme.txt

So, I've put Doxygen markup code into disclaimer.txt and readme.txt, and I updated the EXAMPLE_PATH in my Doxyfile to be:

EXAMPLE_PATH=./

Finally, in project.txt, I just added the lines:

\include disclaimer.txt
\include readme.txt

I expected disclaimer.txt and readme.txt to be imported into project.txt so they are treated as Doyxgen markup, but instead, they are interpreted as text, and are rendered as-is in a code block, as if wrapped by \code and \endcode tags, making the include operation useless.

Is there some way to include additional Doxygen configuration files and actually have them parsed?

Thank you.

4

2 回答 2

1

引用文档：

\include 此命令可用于将源文件作为代码块包含在内。

这似乎与您看到的行为一致。

我不确定您是否可以根据需要将页面包含到其他页面中。

我能看到的最好的解决方案是\subpage改用它，它既会创建指向其他页面的链接，也会使它们成为主页的子页面（这将在 html 相关页面部分显示为下拉层次结构）。

里面的用法project.txt是：

\subpage disclaimer
\subpage readme

假设disclaimer.txt包含这样的行\page disclaimer Disclaimer

还要确保它*.txt在你的FILE_PATTERNS.

于 2013-11-22T18:41:51.343 回答
0

我认为您不能像这样在代码中的任意点包含 Doxygen 配置文件。我知道你可以将它添加到你的文件列表中，等等：

INPUT   = ../PATH_TO_SOURCE_CODE_HEADER_1.h  \
          ./project.txt                      \
          ./disclaimer.txt                   \
          ./readme.txt

此外，请确保您的每个.txt文件都使用 C 进行包装，例如/**，*/如果您使用的是 C。

于 2013-11-22T18:28:29.227 回答