Windowed projects/mkdcppw

MKDCPP(MKDCPPW)                                                MKDCPP(MKDCPPW)



NAME
       mkdcpp - make documentation.   Extrait les informations codées dans les
       programmes sources de  style  C++  (C,  C++  ou  PHP)  et  produit  une
       documentation  spécifique.  mkdcpp est un programme d'épreuve du module
       cpp.c(2) de mkd(1) anciennement  mkdoc(1).  (mkdcppw  est  une  version
       graphique de mkdcpp)


SYNOPSIS
       mkdcpp [-- Options (nstv)] [- Codes (DHOPSTUw(5 max)] path_source

       mkdcppw

DESCRIPTION
       Les  commentaires  à  sélectionner  (ou  tous  les  commentaires)  sont
       extraits du fichier source de style C++  et  produit  la  documentation
       désirée  dans  un  fichier  texte  cible. Les documents usuels sont des
       Organigrammes, Structures, commentaires pour  Programmeurs,  points  de
       Test et d'attention ... Les informations sont extraites grâce aux Codes
        'O',  'S',  'P',  'www',  et  'T'   placés  juste  après les signes de
       commentaire.  Sans  Codes  dans  la  ligne  de   commande,   tous   les
       commentaires  sont  extraits. Le fichier cible aura le même nom et même
       chemin que le fichier source, avec l'extension ´.txt´ .

OPTIONS
       --n    ajoute le numéro de la ligne extaite du fichier source.

       --s    ajoute  le  texte  extrait  à  l'écran  qui  permet   une
              redirection.

       --t    Les  signes  de commentaire ne sont pas extraits. Seul le
              texte est copié.

       --v    (verbose) mode bavard.

EXAMPLES
       (avec commande shell shell)

       mkdcpp --st -F manual | tar cvzf mkdcpp.1.gz manual.txt
              Produit le manuel  UNIX  en  français  :  manuel.txt,  et
              produit le manuel français mkdcpp.1.gz

       sudo     mkdcpp     --st     -M     manual     |     tar    cvzf
       /usr/local/man/man1/mkdcpp.1.gz manual.txt
              Produit     le      manuel      UNIX      en      anglais
              /usr/local/man/man1/mkdcpp.1.gz

       mkdcpp --nst -S cpp.c
              Produit  une  documentation  sur  la structure du fichier
              cpp.c.

       mkdcpp --nst -OH mkdcpp.c
              Produit  l'organigramme  de  mkdcpp.c.  Les   Codes   des
              commentaires  utilisés  sont  'O'  pour organigramme, 'H'
              pour entête (header).

EXIT STATUS
       mkdcpp (sans argument)  Cause  une  erreur  et  la  syntaxe  est
       transmise au terminal.

AUTHOR
        Contributeur                      JP                     LOUYOT
       http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-
       LINUX

BUGS
       Ce  programme  ne  lit  et ne décode pas les fichiers extérieurs
       appelés par include dans le fichier source.

COPYRIGHT
       Copyright (C) Licence EUPL 2010,  2012,  Editeurs  Européens  de
       Logiciels Libres.




10 Décembre 2012                       1                       MKDCPP(MKDCPPW)