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.

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

альтернативой может быть Doxygen preprocessing или INPUT_FILTER.

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

Answer 2

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