从其他页面的部分生成 Doxygen 页面答案

【问题标题】：Doxygen page generation from parts of other pages从其他页面的部分生成 Doxygen 页面
【发布时间】：2009-10-09 12:59:11
【问题描述】：

我有一个包含 doxygen cmets 的文件（比如 file1.doxy）：

/**
 * Comment block 1
*/

...

/**
 * Comment block 2
 */

...

/**
 * Comment block 3
 */

我想创建文件file2.doxy，其输出与以下内容相同：

/**
 * Comment block 1
 *
 * Comment block 3
 */

实际上我想从文件file2.doxy中引用文件file1.doxy，而不是从file1.doxy中复制粘贴信息，但是我可以将需要的标记标签插入到file1.doxy中。

doxygen 有可能这样做吗？

【问题讨论】：

标签： documentation doxygen

【解决方案1】：

你可以使用\verbinclude <file-name>，像这样：

file1.doxy:

/**
 * @verbinclude file1.doc
 */
function f1() {}

/**
 * @verbinclude file2.doc
 */
function f2() {}

/**
 * @verbinclude file3.doc
 */
function f3() {}

file2.doxy:

/**
 * @verbinclude file1.doc
 *
 * @verbinclude file3.doc
 */
function f1() {}

file1.doc、file2.doc、file3.doc 分别包含 Comment block 1、Comment block 2 和 Comment block 3。为此，您必须将Doxyfile 中的EXAMPLE_PATH 设置为file{1,2,3}.doc (*) 的路径。不过，这不会在file{1,2,3}.doc 中扩展@doxygen 命令。

另一种方法是使用 doxygen preprocessing 或 INPUT_FILTER。

(*) 您可能还需要将 EXTRACT_ALL 设置为 YES

【讨论】：

【解决方案2】：

根据原始注释块的性质，是的，您可以在 Doxygen cmets 中使用 @copydoc 命令将块的副本拉入另一个文件。

【讨论】：