« Mkd (Extracteur de documents)/La commande mkd » : différence entre les versions
Contenu supprimé Contenu ajouté
m →Description : Corrections de syntaxe |
m →Exemples : Modification des titres de section pour une meilleure compréhension |
||
Ligne 170 :
== Exemples ==
===
Quand c'est possible on écrit chaque fonction d'une application dans un [[w:Fichier informatique|fichier]] séparé, afin de produire une documentation dans un ordre alphabétique. <br />
Quand les fonctions sont regroupées dans un même fichier, la documentation des fonctions apparaîtra dans le même ordre que dans le fichier.
Ligne 277 :
</source>
===
* '''Exemple de fichier d'entête obtenu par la commande:'''<br />mkd -Ctw H cpp.c cpp.h<br />
:''Fichier cpp.h:''
Ligne 335 :
</source>
===
Le fichier '''Update_mkd_en.1.txt''' doit être imposé au format UTF-8 avec un éditeur comme gedit ou BlueFish, pour être traduisibles dans toutes les langues. Vérifiez votre syntaxe avec GmanEdit (Éditeur Gnome)<ref>[http://gmanedit.sourceforge.net/ GmanEdit (Gnome manpage editor)]</ref><br />''Note: Ceci est un exemple; Voir aussi: [[Mkd_(Extracteur_de_documents)/Manuels#Installation|Installation du manuel {{fr}}]]
<source lang="bash">
Ligne 373 :
</source>
=== Exemple de Makefiles pour générer la documentation ===
Toutes les chemins des fichiers de l'application sont regroupés dans un fichier de projet dans l'ordre alphabétique.
:Exemple : "'''ls -1 *.c > app.prj'''" qui va contenir le nom de tous les fichiers à examiner pour générer la [[w:Documentation logicielle|documentation]]. '''''Attention''', ls -1 (chiffre un) et non -l (lettre 'l')''
| |||