LIST OF FILES

  1. ./pistMkDoc.tcl


LIST OF PROCS in ./pistMkDoc.tcl

Fichier permettant de parser un ou plusieurs fichiers TCL en vue de générer automatiquement une documentation HTML sur ces fichiers. La méthode consiste à utiliser plusieurs fichiers temporaires puis de concaténer ces fichiers pour genérer un fichier HTML.
Description des fichiers temporaires :
$pistMkDoc(tmpDir)/lof.tmp : Contient la liste des fichiers dont on veut genérer une documentation. Ce channel est mémorisé dans pistMkDoc(lof) (lof comme Liste Of File)
La procédure parseTCLFile utilise 2 fichiers temporaires :
$pistMkDoc(tmpDir)/lop.tmp : Contiendra la liste des procédures dans fichier TCL parsées par parseTCLFile (lop comme Liste Of Proc)
$pistMkDoc(tmpDir)/dop.tmp : Contient la description HTML des procédures du fichier TCL parsées par parseTCLFile (dop comme Description Of Proc)
Enfin un dernier fichier est nécessaire comme accumulateur :
$pistMkDoc(tmpDir)/ldop.tmp : Contient la description des fichiers TCL déjà parsée par la procédure parseTCLFile. Ce channel est mémorisé dans pistMkDoc(ldop) (ldop comme Liste and Description Of Proc)
  1. lempty Return 1 if it argument is empty
  2. recursive_glob Retourne une liste récursive d'éléments d'un répertoire
  3. showHelp Imprime l'aide pour utiliser html2htcl.
  4. addLine Parse une chaîne TCL, pour en extraire les commentaires
  5. insereInfo Parse une chaîne TCL, pour en extraire les commentaires
  6. parseTCLFile Parse un fichier TCL, pour en extraire les commentaires
  7. pistMkDoc Permet de tester les arguments passes au package pistMkDoc
  1. lempty

    Return 1 if it argument is empty

    lempty list => return 1 if list is empty, 0 otherwise one can use insteed : if ![llength $my_list] {...} insteed of : if [lempty $my_list] {...}


  2. recursive_glob

    Retourne une liste récursive d'éléments d'un répertoire

    Retourne une liste récursive de fichiers ou répertoires sous la forme dir/relativeFilePath. Attention la liste optenue peut contenir des répertoires ou des doublons (de la meme façon que la commande UNIX "ls * *)"

    1. Arguments
      1. dirlist Répertoire de base où va s'effectuer la recherche
      2. globlist Pattern permettant de selectionner les fichiers
    2. Exemple
      recursive_glob . * retourne {./rep1 ./fich1 ./fich2 ./rep1/fic11 ./rep1/fic12 ....}
    3. Remarque
      Attention si globlist contient ".*" alors les répertoires de la forme ".../." et .../.." font partie du résultat !!
    4. Exemple d'utilisation
      set ABS [recursive_glob [pwd] $listOfPatterns] : liste de noms absolus
      set REL [lcutleft $ABS [expr [string length [pwd]] + 1]] : liste de noms relatifs
    5. Modif 10/06/96
      compatibilité Mac et Windows (utilisation de la commande file join...).
      Problemes potentiels avec les fichiers invisibles pour unix (* et .*)


  3. showHelp

    Imprime l'aide pour utiliser html2htcl.


  4. addLine

    Parse une chaîne TCL, pour en extraire les commentaires

    Cette fonction supprime les "#" en début de ligne

    1. Arguments
      1. dop Nom du fichier où les infos en HTML doivent être sauvées
      2. comment Contenu du commentaire
    2. Effets de bord
    3. Calls
    4. Outputs
      Ajoute des informations dans le fichier pointé par dop
    5. Returns


  5. insereInfo

    Parse une chaîne TCL, pour en extraire les commentaires

    Procédure permettant de parser une chaîne Tcl, pour en extraire des données HTML en vue de générer une documentation automatique. Si categorie vaut "Arguments" parse une chaine du type

    "# arg1 - Infos sur l'argument 1
    Complément d'information sur l'argument 1
    # arg2 - Infos sur l'argument 2
    etc..."
    pour générer une liste en HTML. Sinon renvoie le simplement le texte en supprimant les "#" en tête de ligne
    1. Arguments
      1. dop Nom du fichier où les infos en HTML doivent être sauvées
      2. categorie Catégorie du commentaire
      3. categorieComment Contenu du commentaire
    2. Effets de bord
    3. Calls
      addLine
    4. Outputs
      Ajoute des informations dans le fichier pointé par dop
    5. Returns


  6. parseTCLFile

    Parse un fichier TCL, pour en extraire les commentaires

    Procédure permettant de parser un fichier Tcl, pour en extraire des données HTML en vue de générer une documentation automatique.

    1. Arguments
      1. fileName Nom du fichier HTML à parser
    2. Effets de bord
      Crée 2 fichier temporaire dans le repertoire temporaire pointé par pistMkDoc(tmpDir)
    3. Calls
      insereInfo
    4. Outputs
      remplit les fichiers dont les noms sont contenus dans les variables : pistMkDoc(ldop) et pistMkDoc(lof)
    5. Returns


  7. pistMkDoc

    Permet de tester les arguments passes au package pistMkDoc

    1. Arguments
      1. -files "Liste de fichier" Specifier une liste de fichier+un pattern
        Permet de specifier une liste de fichier+un pattern
        Exemple : "-files ./*.tcl ./*.tk"
      2. -f a force l'effacement des fichiers
      3. -out FileName Nom du fichier HTML de sortie
      4. -tmp Directory Emplacement des fichiers temporaires
        Si cette option n'est pas précisée, les fichiers temporaires seront placés dans les répertoire courant, ou bien dans le même répretoire que le fichier HTML de sortie si l'option -out est précisée.
      5. -h Affiche l'aide concernant l'utilisation de pistMkDoc
    2. Effets de bord
      remplit le tableau global "pistMkDoc" avec les paramètres passés au programme
    3. Calls
      pistMkDocInit, recursive_glob, showHelp, parseTCLFile, pistMkDocClose.
    4. Outputs
    5. Returns