如何在Doxygen中包含自定义文件 [英] How to include custom files in Doxygen

问题描述

我想添加自定义（非项目）文件以使用 Doxygen 生成一些额外的页面。

I would like to add custom (non-project) files to generate some extra pages with Doxygen.

我（实际上）不确定如何命名这些文件以及应如何格式化其内容。

I am (was actually) unsure how these files should be named and how their content should be formatted.

推荐答案

在找到答案之前，我已经进行了很多搜索，所以我认为分享起来会很愉快！

I having been searching quite a lot before I found the answer, so I thought it would be nice to share!

根据这篇 Doxygen陷阱文章我终于发现：您需要添加一个文件扩展名为 dox 。它的内容应包含C样式的注释块：

According to this Doxygen gotchas article I finally found that: you need to add a file with the dox extension. Its content should contain C-style comment blocks:

/*!
  \page My test page
  contents
  ...
  more contents
*/

确保将您的自定义文件放在 INPUT 设置；如果INPUT留空，则在当前目录中，这样就可以找到这些文件。

Make sure your custom files are placed in a directory which is included in INPUT setting or in the current directory if INPUT is left empty, so these files can be found.

这篇关于如何在Doxygen中包含自定义文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！