mkddocu(1) Linux User's Manual mkddocu(1)
NOM
mkddocu - Cette commande shell génère la documentation informatique de tout fichier de
projet reconnu par le logiciel mkd.
SYNOPSIS
mkddocu [projet] [-s]
DESCRIPTION
La commande mkd associée à mkddocu, extrait les commentaires dotés d'un caractère
repère.
Exemple : //D ceci est un commentaire php repéré par le caractère 'D'
Si des fichiers de langage C sont présents, mkddocu génère un fichier d'entête global
(header) du projet informatique.
Repère :
D - Extrait la documentation générale.
H - Crée le fichier d'entête global (header) si un fichier C est présent.
P - Extrait un document utile aux mainteneurs, noms, dates, versions, etc.
T - Extrait le document des directives de tests. (Unitaires, d'intégration, etc.)
OPTIONS
projet Cette option permet de choisir un nom de projet différent de project par défaut.
Si 'projet' est le caractère '?' la commande affiche la syntaxe.
-s Cette option précise qu'il faut générer le fichier des chaînes de caractères et
le fichier des chaînes utiles aux traductions avec gettext et poedit.
VALEURS RETOURNÉES
0 : Fin normale à la fin de l'exécution de la commande ou de l'aide (syntaxe).
-1 : La commande mkd n'est pas installée.
-2 : Arrêt de la commande. La sauvegarde de la série de documents dans Backups n'a pas
été effectuée.
EXEMPLES
L'auto-documentation de cette commande se crée avec le fichier d'origne mkddocu.sh
Lancer la commande 'mkddocu.sh mkddocu -s'
Le répertoire maintenance/mkddocu contiendra les documents.
Les répertoires de projet sont générés par séries et peuvent avoir été sauvegardés dans
un répertoire Backups si le nombre de fichiers de projet de la série a atteind la lim‐
ite BACKUPSMAX
Pour les essais on peut se limiter à BACKUPSMAX=2 (3 'backups' par série.)
REMARQUES
BACKUPSMAX est normalement fixé à 9 mais peut être modifié par édition du fichier :
/usr/bin/mkddocu.
VOIR AUSSI
mkd(1) xgettext(1) poedit(1)
TÉLÉCHARGEMENTS
http://edeulo.free.fr
AUTEURS
Clara, JPL, Luca
Email : http://edeulo.free.fr/contacts/formmail.php
BUGS
Rapports de bugs : http://edeulo.free.fr/phpBB3/viewforum.php?f=14
2014-02-24
