2017-05-24 3 views
0

Supposons que j'ai un fichier d'en-tête avec quelques fonctions et plusieurs fichiers source qui implémentent les fonctions fournies par l'en-tête. Je voudrais documenter les fonctions en utilisant Doxygen, mais seulement les commentaires généraux concernant toutes les implémentations, pas spécifiques à l'implémentation.Doxygen: documentation d'une API unique avec plusieurs implémentations

Quelle est la meilleure façon de voir uniquement les commentaires d'en-tête? Je ne peux pas configurer la configuration pour ignorer tous les fichiers source car certains autres fichiers source des projets ne possèdent aucun en-tête.

Par exemple:

api.h

/** 
* @details 
* This is general comment for header 
* 
*********************************************************************/ 

implemenation1.c

/** 
* @details 
* This is implementation specific comment for file 1 
* 
*********************************************************************/ 
int foo(int a, int b) 
{ 
    ... 
} 

implemenation2.c

/** 
* @details 
* This is implementation specific comment for file 2 
* 
*********************************************************************/ 
int foo(int a, int b) 
{ 
    ... 
} 

Je veux voir que ce commentaire sur Doxygen:

This is general comment for header 

Merci à l'avance!

+1

Peut-être jeter un oeil à \ cond et \ if construit? – albert

+0

ouais, ça résout, même si j'espérais avoir une solution plus élégante. – Vardit

Répondre

0

Le meilleur solultion que j'ai trouvé est jusqu'à présent ceci:

api.h

/** 
* @details 
* This is general comment for header 
* 
*********************************************************************/ 

implemenation1.c

/** 
* @details 
* This is implementation specific comment for file 1 
* 
* @cond 
*********************************************************************/ 

int foo(int a, int b) 
{ 
    ... 
} 

/** @endcond */ 

implemenation2.c

/** 
* @details 
* This is implementation specific comment for file 2 
* 
* @cond 
*********************************************************************/ 

int foo(int a, int b) 
{ 
    ... 
} 

/** @endcond */ 
+0

Je voudrais même déplacer la cond dans le bloc de documentation. – albert

+0

Terminé. Merci! :) – Vardit

+0

Je voulais dire même au-dessus des détails, il suffit de vérifier les résultats. – albert