Documentation Can';t正确导入/包含外部doxygen配置文件

Documentation Can';t正确导入/包含外部doxygen配置文件,documentation,doxygen,doxywizard,Documentation,Doxygen,Doxywizard,我有一个简单的doxygen项目,由Doxyfile和一个配置文件project.txt组成。在project.txt文件中,我有一些手动编写的文档,这些文档使用交叉引用从我的代码中自动生成的文档,并且一切正常 我试图将我的项目分为几个小节,如: project.txt disclaimer.txt readme.txt 因此,我将Doxygen标记代码放入disclaimer.txt和readme.txt,并将Doxyfile中的示例路径更新为: EXAMPLE_PATH=./ 最后,在p

我有一个简单的doxygen项目,由
Doxyfile
和一个配置文件
project.txt
组成。在
project.txt
文件中,我有一些手动编写的文档,这些文档使用交叉引用从我的代码中自动生成的文档,并且一切正常

我试图将我的项目分为几个小节,如:

project.txt
disclaimer.txt
readme.txt
因此,我将Doxygen标记代码放入
disclaimer.txt
readme.txt
,并将
Doxyfile
中的
示例路径更新为:

EXAMPLE_PATH=./
最后,在
project.txt
中,我刚刚添加了几行:

\include disclaimer.txt
\include readme.txt
我希望
disclaimer.txt
readme.txt
被导入到
project.txt
中,因此它们被视为Doyxgen标记,但相反,它们被解释为文本,并以代码块的形式呈现,就像被
\code
\endcode
标记包装一样,这使得include操作毫无用处

是否有办法包含额外的Doxygen配置文件并实际解析它们


谢谢。

我不认为您可以在代码中的任意位置包含Doxygen配置文件。我知道您可以将其添加到您的文件列表中,等等:

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

另外,如果您使用的是C,请确保每个
.txt
文件都用
/**
*/
包装。

我认为您不能在代码中的任意点包含Doxygen配置文件。我知道您可以将其添加到您的文件列表中,等等:

INPUT   = ../PATH_TO_SOURCE_CODE_HEADER_1.h  \
          ./project.txt                      \
          ./disclaimer.txt                   \
          ./readme.txt
此外,如果您使用C,请确保每个
.txt
文件都用
/**
*/
包装。例如,引用:

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

这似乎与你看到的行为一致

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

我能看到的最佳解决方案是使用
\subpage
,这将创建指向其他页面的链接,并使它们成为主页的子页面(这将在html相关页面部分中显示为下拉层次结构)

project.txt中的用法是:

\subpage disclaimer
\subpage readme
假设
disclaimer.txt
包含类似
\page disclaimer disclaimer

还要确保
*.txt
在您的
文件中

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

这似乎与你看到的行为一致

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

我能看到的最佳解决方案是使用
\subpage
,这将创建指向其他页面的链接,并使它们成为主页的子页面(这将在html相关页面部分中显示为下拉层次结构)

project.txt中的用法是:

\subpage disclaimer
\subpage readme
假设
disclaimer.txt
包含类似
\page disclaimer disclaimer


还要确保
*.txt
在您的
文件中\u PATTERNS

值得注意的是,doxygen从1.8.2开始就支持标记-因此,您可以在
.md
.markdown
文本文件中使用带有简单易读的粗体强调等的普通文本,而不是带有奇怪的C样式分隔注释的.txt。@Cheeseminer很高兴知道。谢谢。值得注意的是,doxygen从1.8.2开始就支持标记-因此,您可以在
.md
.markdown
文本文件中使用带有简单易读的粗体强调等的普通文本,而不是带有奇怪C样式分隔注释的.txt。@Cheeseminer很高兴知道。非常感谢。