我有一个简单的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
标记包装一样,使得include操作无用。
是否有某种方法可以包含其他Doxygen配置文件并实际解析它们?
谢谢。
答案 0 :(得分:1)
引用the docs:
\ include此命令可用于将源文件包含为代码块。
这似乎与你看到的行为一致。
我不确定您是否可以根据需要将页面包含在其他页面中。
我可以看到的最佳解决方案是使用\subpage
代替,这将创建指向其他页面的链接并使其成为主页面的子页面(这将在html相关页面部分中显示为下拉列表层次)。
project.txt
内的用法是:
\subpage disclaimer
\subpage readme
假设disclaimer.txt
包含\page disclaimer Disclaimer
还要确保*.txt
中有FILE_PATTERNS
。
答案 1 :(得分:0)
我认为您不能在代码中的任意点包含Doxygen配置文件。我知道你可以把它添加到你的文件列表中,等等:
INPUT = ../PATH_TO_SOURCE_CODE_HEADER_1.h \
./project.txt \
./disclaimer.txt \
./readme.txt
另外,例如,如果您使用的是C,请确保每个.txt
文件都包含/**
和*/
。