Генерация страниц Doxygen из частей других страниц

Question

У меня есть один файл (скажем, file1.doxy) с комментариями doxygen:

/**
 * Comment block 1
*/

...

/**
 * Comment block 2
 */

...

/**
 * Comment block 3
 */

И я хочу создать файл file2.doxy, выход которого совпадает с:

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

На самом деле я хочу сослаться на файл file1.doxy из файла file2.doxy, а не копировать и вставлять информацию из file1.doxy, но я могу вставить необходимые метки в файл file1.doxy.

Возможно ли это сделать с помощью кислорода?

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 соответственно. чтобы это работало, вы должны установить EXAMPLE_PATH в вашем Doxyfile на путь file{1,2,3}.doc (*). однако это не расширит команды @ doxygen в file{1,2,3}.doc.

альтернативой может быть использование doxygen предварительной обработки или INPUT_FILTER.

(*) вам также может потребоваться установить EXTRACT_ALL на YES

Answer 2

В зависимости от характера исходных блоков комментариев, да, вы можете использовать команду @ copydoc в ваших комментариях Doxygen, чтобы вытянуть копии блоков в другой файл.