Doxygen Page générée à partir de pièces d'autres pages

Question

J'ai un fichier (par exemple) avec file1.doxy commentaires doxygen:

/** 
* Comment block 1 
*/ 

... 

/** 
* Comment block 2 
*/ 

... 

/** 
* Comment block 3 
*/ 

Et je veux créer le fichier file2.doxy dont la sortie est le même que:

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

en fait, je veux faire référence à déposer file1.doxy du fichier file2.doxy et non à l'information copier-coller à partir file1.doxy, mais je peux insérer des balises de marquage nécessaire dans file1.doxy.

Est-il possible de le faire avec doxygen?

Answer 1

vous pouvez utiliser \verbinclude <file-name>, comme ceci:

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() {} 

avec file1.doc, file2.doc, file3.doc contenant Comment block 1, Comment block 2 et Comment block 3, respectivement. pour que cela fonctionne, vous devez définir le EXAMPLE_PATH dans votre Doxyfile sur le chemin de file{1,2,3}.doc (*). cela ne va pas développer les commandes @ Doxygen dans file{1,2,3}.doc, cependant. Une alternative pourrait être l'utilisation de Doxygen preprocessing ou INPUT_FILTER.

(*) vous pourriez aussi avoir à mettre EXTRACT_ALL à YES

Answer 2

En fonction de la nature des blocs de commentaires originaux, oui, vous pouvez utiliser la commande @copydoc dans vos commentaires Doxygen pour tirer des copies des blocs dans un autre fichier.