Projet mkd/mkddocu.sh

De Wiki EELL.

(Différences entre les versions)
m (Création de la page)
m (Définition des chapitres)
Ligne 1 : Ligne 1 :
-
<!-- {{Modèle:Pas fini/autre}} -->
+
<!-- --> {{Modèle:Pas fini/autre}}
<small>[[Projet mkd/Fichiers en développement|Retour aux fichiers en développement &rarr;]]</small>
<small>[[Projet mkd/Fichiers en développement|Retour aux fichiers en développement &rarr;]]</small>
-
== Fichiers de la fonction tri() ==
+
== mkddocu.sh ==
 +
Dans sa version finale le fichier sera renommé mkddocu et copié dans les répertoires /usr/bin (ou /usr/local/bin)
 +
 
 +
=== Document initial ===
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
#!/bin/bash
 +
#P File mkddocu writed by Clara Jimenez 2013-12-15
 +
#P Fichier modifié par JPL le 22/02/2014 pour une version plus universelle
 +
#P Util : Create any debian package for mkd for multi-lang programming languages
 +
#
 +
#D Fichier mkddocu.sh
 +
#D -----------------------------------------------------------------------------
 +
#D Documentation : Manuel mkddocu(1)
 +
#D Cette commande doit être placée dans le répertoire /usr/bin
 +
#D
 +
#D NOM
 +
#D    mkddocu  -  Cette commande shell génère la documentation informatique de tout fichier de
 +
#D    projet reconnu par la commande mkd
 +
#D
 +
#D SYNOPSYS
 +
#D    mkddocu [nom] [-s]
 +
#D
 +
#D DESCRIPTION
 +
#D    La commande mkd associée à mkddocu, extrait les commentaires  dotés  d'un  caractère  de
 +
#D    repère.
 +
#D    Si  des  fichiers  de langage C sont présents, mkddocu génère un fichier d'entête global
 +
#D    (header) du projet informatique.
 +
#D
 +
#D    Caractère de repère
 +
#D      D - Extrait la documentation générale.
 +
#D      T - Extrait le document des directives de tests.
 +
#D      P - Extrait un document utile aux mainteneurs.
 +
#D
 +
#D OPTIONS
 +
#D    nom    Cette option permet de choisir un nom de  projet  différent  du  nom  par  défaut
 +
#D          project.  Si nom est le caractère '?' la commande affiche la syntaxe.
 +
#D
 +
#D    -s      Cette  option  génère  le  fichier  des  chaînes  de caractères et le fichier des
 +
#D          chaînes de caractères utiles aux traductions avec gettext et poedit.
 +
#D
 +
#D VALEURS RETOURNÉES
 +
#D    0 : Fin normale à la fin de l'exécution de la commande.
 +
#D    1 : Fin normale après l'affichage de la syntaxe de la commande.
 +
#D    -1 : Sortie sans sauvegarde de la série de documents dans Backups.
 +
#D
 +
#D EXEMPLES :
 +
#D    L'auto documentation de cette commande se crée  en  renommant  pour  l'usage  mkddocu.sh
 +
#D    L'extension importe peu, la commande sera gérée par bash. Les fichiers sans extension ou
 +
#D    avec l'extension .bash ne sont pas pris en compte.
 +
#D    compte.
 +
#D    Lancer la commande 'mkddocu.sh mkddocu -s'
 +
#D    Le répertoire maintenance/mkddocu contiendra la documentation
 +
#D    Les répertoires de projet sont générés par séries et peuvent avoir été sauvegardés  dans
 +
#D    un répertoire Backups si le nombre de fichiers de projet de la série ont atteind la lim‐
 +
#D    ite BACKUPSMAX
 +
#D    Pour les essais on peut se limiter à BACKUPSMAX=2 (3 'backups' par série.)
 +
#D
 +
#D REMARQUES
 +
#D    BACKUPSMAX est normalement fixé à 9 mais peut être modifié par édition du fichier.
 +
#D
 +
#D VOIR AUSSI
 +
#D    mkd(1) gettext(1) poedit(1)
 +
#D
 +
#D TÉLÉCHARGEMENTS
 +
#D    http://edeulo.free.fr
 +
#D
 +
#D AUTEURS
 +
#D    Clara, JPL
 +
#D    Email : http://edeulo.free.fr/contacts/formmail.php
 +
#D
 +
#D BUGS
 +
#D    Rapports de bugs : http://edeulo.free.fr/phpBB3/index.php
 +
#D
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
=== La commande shell ===
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
 
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
=== Directive des tests ===
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
 
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
== Test des paramètres d'entrée ==
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
 
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
== Test de la boucle des sauvegardes ==
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
 
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
== Test de la reconnaissance des fichiers C ==
 +
{{Boîte déroulante/début|titre=doc mkddocu.sh créé le 28 février 2014}}
 +
<pre style="color:blue>
 +
 
 +
</pre>
 +
{{Boîte déroulante fin}}
 +
 
 +
== Analyse globale ==

Version du 26 février 2014 à 15:48

Cette page n'est pas finie. Veuillez considérer le plan et le contenu comme incomplets et en préparation, temporaires et sujets à caution. Si vous souhaitez participer, il vous est recommandé de consulter sa page de discussion au préalable.

Retour aux fichiers en développement →

Sommaire

mkddocu.sh

Dans sa version finale le fichier sera renommé mkddocu et copié dans les répertoires /usr/bin (ou /usr/local/bin)

Document initial

doc mkddocu.sh créé le 28 février 2014
#!/bin/bash
#P File mkddocu writed by Clara Jimenez 2013-12-15
#P Fichier modifié par JPL le 22/02/2014 pour une version plus universelle
#P Util : Create any debian package for mkd for multi-lang programming languages
#
#D Fichier mkddocu.sh
#D -----------------------------------------------------------------------------
#D Documentation : Manuel mkddocu(1)
#D Cette commande doit être placée dans le répertoire /usr/bin
#D 
#D NOM
#D    mkddocu  -  Cette commande shell génère la documentation informatique de tout fichier de
#D    projet reconnu par la commande mkd
#D
#D SYNOPSYS
#D    mkddocu [nom] [-s]
#D
#D DESCRIPTION
#D    La commande mkd associée à mkddocu, extrait les commentaires  dotés  d'un  caractère  de
#D    repère.
#D    Si  des  fichiers  de langage C sont présents, mkddocu génère un fichier d'entête global
#D    (header) du projet informatique.
#D
#D    Caractère de repère
#D       D - Extrait la documentation générale.
#D       T - Extrait le document des directives de tests.
#D       P - Extrait un document utile aux mainteneurs.
#D
#D OPTIONS
#D    nom    Cette option permet de choisir un nom de  projet  différent  du  nom  par  défaut
#D           project.  Si nom est le caractère '?' la commande affiche la syntaxe.
#D
#D    -s      Cette  option  génère  le  fichier  des  chaînes  de caractères et le fichier des
#D           chaînes de caractères utiles aux traductions avec gettext et poedit.
#D
#D VALEURS RETOURNÉES
#D     0 : Fin normale à la fin de l'exécution de la commande.
#D     1 : Fin normale après l'affichage de la syntaxe de la commande.
#D     -1 : Sortie sans sauvegarde de la série de documents dans Backups.
#D 
#D EXEMPLES :
#D    L'auto documentation de cette commande se crée  en  renommant  pour  l'usage  mkddocu.sh
#D    L'extension importe peu, la commande sera gérée par bash. Les fichiers sans extension ou
#D    avec l'extension .bash ne sont pas pris en compte.
#D    compte.
#D    Lancer la commande 'mkddocu.sh mkddocu -s'
#D    Le répertoire maintenance/mkddocu contiendra la documentation
#D    Les répertoires de projet sont générés par séries et peuvent avoir été sauvegardés  dans
#D    un répertoire Backups si le nombre de fichiers de projet de la série ont atteind la lim‐
#D    ite BACKUPSMAX
#D    Pour les essais on peut se limiter à BACKUPSMAX=2 (3 'backups' par série.)
#D
#D REMARQUES
#D    BACKUPSMAX est normalement fixé à 9 mais peut être modifié par édition du fichier.
#D
#D VOIR AUSSI 
#D    mkd(1) gettext(1) poedit(1)
#D
#D TÉLÉCHARGEMENTS
#D    http://edeulo.free.fr
#D
#D AUTEURS
#D    Clara, JPL
#D    Email : http://edeulo.free.fr/contacts/formmail.php
#D
#D BUGS
#D    Rapports de bugs : http://edeulo.free.fr/phpBB3/index.php
#D
 

La commande shell

doc mkddocu.sh créé le 28 février 2014
 

Directive des tests

doc mkddocu.sh créé le 28 février 2014
 

Test des paramètres d'entrée

doc mkddocu.sh créé le 28 février 2014
 

Test de la boucle des sauvegardes

doc mkddocu.sh créé le 28 février 2014
 

Test de la reconnaissance des fichiers C

doc mkddocu.sh créé le 28 février 2014
 
== Analyse globale ==
Récupérée de « http://edeulo.free.fr/wiki/index.php/Projet_mkd/mkddocu.sh »
Outils personnels