Discussion :

[C3d21c]

Bonjour

je commence à utiliser Doxygen. j'ai bien compris le principe de documentation des en-têtes de fichier, de fonction etc...

Mais j'aimerais pourvoir documenter une fonction de ce type

Code :

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

1
2
3
4
5
6
7
 
/** Test sur toto */
if(toto==0)
{
    /** Mise a jours toto */
    toto=1;
}

Le résultat souhaité est d'avoir une indentation dans la doc Doxygen.
ce qui permet de sortir un algo texte.

il y a peut être d'autres solutions pour documenter le code (Doxygen).
tt les idées sont bonnes à prendre.

Merci

[gerald3d]

Je vais essayer d'apporter une réponse qui ne répond pas directement à la question malheureusement .

J'ai tendance à utiliser les balises "\code" "\endcode". Elles permettent d'insérer un code brute sans interprétation des espaces, ce qui permet d'afficher correctement un morceau de code source dans la documentation.

L'inconvénient de cette technique est qu'il faut recopier le code source à l'intérieur de ces balises. Aussi, si le code source change, il faut aussi malheureusement changer la documentation qui y est attachée.

[C3d21c]

Merci pour cette commande.

Mais en effet elle ne répond pas tout à fait à mes attentes.
Je me demande si Doxygen est adapté à ce que je souhaite faire.

Merci

[Franck.H]

Franchement, je ne sais pas si une telle commander existe, à une époque j'avais pondu un tutoriel sur Doxygen/Doxywizard mais en parcourant les commandes il ne me semblais pas avoir vu une telle chose à par la commande \code ou \include qui elle permet d'intégrer un fichier (txt, c, ou autre) et c'est par commande que j'ai intégré dans une de mes docs des exemples de code.

[C3d21c]

Merci Franck.H

En effet la commande \include me parait intéressante.
Par contre je ne trouve pas d'informations sur cette commande.
Avez vous des exemples et savez vous quel type de fichier est accepté.

Merci bcp.

Votre tuto Doxygen m'a beaucoup aidé à la compréhension de ce dernier.

[Franck.H]

Par contre je ne trouve pas d'informations sur cette commande.

N'importe quel type de fichier, même sans extension ! Pour la commande, dans un bloc de commentaire:

Code :

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

\include exemple.txt

Tout simplement