我有一个简单的doxygen项目,包括Doxyfile
和配置文件project.txt
。在project.txt
文件中,我有一些手动编写的文档,它使用来自我的代码的自动生成文档的交叉引用,一切正常。
我试图将我的项目分解为子部分,例如:
project.txt
disclaimer.txt
readme.txt
所以,我把Doxygen标记代码放入disclaimer.txt
和readme.txt
,我更新了EXAMPLE_PATH
中的Doxyfile
:
EXAMPLE_PATH=./
最后,在project.txt
,我刚刚添加了以下几行:
\include disclaimer.txt
\include readme.txt
我期望将disclaimer.txt
和readme.txt
导入到project.txt
中,因此它们被视为Doyxgen标记,但相反,它们被解释为文本,并在代码块中呈现为原样,就好像由\code
和\endcode
标记包装一样,使得包含操作无用。
有没有办法包含额外的Doxygen配置文件,并实际解析它们?
谢谢。
我不认为您可以在代码中的任意点包含Doxygen配置文件。我知道你可以把它添加到你的文件列表中,等等:
INPUT = ../PATH_TO_SOURCE_CODE_HEADER_1.h \
./project.txt \
./disclaimer.txt \
./readme.txt
另外,例如,如果您使用的是C,请确保每个.txt
文件都包含/**
和*/
。
引用the docs:
\ include此命令可用于将源文件包含为代码块。
这似乎与你看到的行为一致。
我不确定您是否可以根据需要将页面包含在其他页面中。
我能看到的最好的解决方案是使用\subpage
,它将创建一个指向其他页面的链接,并使它们成为主页面的子页面(这将在html相关页面部分显示为下拉层次结构)。
project.txt
中的用法是:
\subpage disclaimer
\subpage readme
假设disclaimer.txt
包含像\page disclaimer Disclaimer
这样的行
还要确保*.txt
在你的FILE_PATTERNS
。