Discussion :

[bladerunners]

Bonjour,

Je dois faire tourner Doxygen sur du code non documenté au format Doxygen/utilisable par Doxygen. J'aimerai savoir si il existe un moyen d'arriver à récupérer les quelques commentaires du code. Je m'explique avec un exemple:

au lieu d'avoir les standards et très pratiques:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
 
/** Mon commentaire pour MaFonction
*/
int MaFonction();
 
ou 
/// Mon commentaire pour MaFonction
int  MaFonction();
 
et consor

J'ai uniquement:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
 
// Mon commentaire pour MaFonction
int  MaFonction();
 
//un commentaire pourri
//int AncienneFonctionQuiTrainneLa()
 
//
//un commentaire qui ne sert à rien, pour faire joli
 
int  MaFonction2(); // Mon commentaire pour ma MaFonction2

Est il possible de modifier les settings de Doxygen pour arriver à utiliser de tels commentaires? Principalement, y a-t-il un moyen de configurer Doxygen pour qu'il prenne la ligne de commentaire au dessus ou à coté d'une fonction comme commentaire?

D'autre part, est-il possible de configurer Doxygen pour surcharger/customiser des tags? Par exemple utiliser

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
// Mon commentaire pour MaFonction
// Inputs:
// - param1 Mon 1er paramètre fait blablabla
// - Return un int qui fait ca
int  MaFonction(int param1);

pour que Doxygen comprenne:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
 
/// Mon commentaire pour MaFonction
/// \param[in] param1 Mon 1er paramètre fait blablabla
/// \return un int qui fait ca
int  MaFonction(int param1);

Pour ce dernier point, j'ai essayé d'utlisé les Alias (c'est la 1ere fois que j'essaie d'utiliser les alias dans Doxygen) pour obetenir au moins des sections personnalisées (par exemple, une section intitulée Inputs parameters). J'ai rajouté les lignes suivantes via le wizard Doxygen ( [Expert] -> onglet Project, section ALIASES)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
 
"// Inputs:=\par Inputs parameters:\n" 
"// - return=\par Returns:\n"

Mais je n'ai pas obtenu de section "Input parameters" ni "Returned values" dans ma documentation. En fait, rien n'a changé.
Quelle est mon erreur pour utiliser les alias pour définir des sections personnalisées dans la doc?

Merci de vos réponses

[Luc Hermitte]

Les alias sont faits pour définir des commandes qui commencent (à l'utilisation !) par \ ou @.

Tu vas devoir te faire une petite moulinette en perl ou autre pour transformer tes fichiers.

[bladerunners]

Merci!

Je voulais être sur qu'il n'y avait pas un moyen de configurer Doxygen avant de faire une moulinette Perl.