Un exemple de plusieurs fichiers source dans Doxygen

Question

Je documente un groupe de classes qui fonctionnent ensemble en utilisant Doxygen et j'ai écrit un exemple réparti sur plusieurs fichiers source (tous référencés par EXAMPLE_PATH). Plus précisément, je l'ai écrit ce qui suit:

/*************************************//** 
* Some context... 
* @example Source1.cpp 
* 
* More context... 
* @example Source2.cpp 
****************************************/ 

Le problème est que la sortie est répartie en deux dans la page générée par exemple Doxygen (une page pour Source1, un autre pour Source2). Je voudrais que ce soit tous sur la même page HTML, le contexte et le code exemple comme un seul tutoriel:

Some context... 
|----------------------------------------------| 
| int main()         | 
| {           | 
| //...          | 
| }           | 
|----------------------------------------------| 

More context... 
|----------------------------------------------| 
| bool fct()         | 
| {           | 
| //...          | 
| }           | 
|----------------------------------------------| 

Est-il possible d'y arriver? J'utilise Doxygen 1.8.11.

Cordialement

Answer 1

J'ai trouvé une solution semi-legit: si vous ajoutez la balise @example au début et à utiliser @include s après, il fonctionne:

/*************************************//** 
* @example "My tutorial" 
* 
* Some context... 
* @include Source1.cpp 
* 
* More context... 
* @include Source2.cpp 
****************************************/ 

Cependant, en regardant à la sortie d'erreur Doxygen Je reçois le message suivant: warning: included file My is not found. Check your EXAMPLE_PATH

La solution n'est pas propre, mais elle est utilisable pour le moment. Si vous avez une meilleure suggestion (par exemple, un avertissement supprimé), veuillez le partager et je l'accepterai.