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

Question

我有一个文件（比如file1.doxy）和doxygen评论：

/**
 * 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可能吗？

Answer 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

Answer 2

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