Haut (retour page principale)

Fichier : tools/ottodok/autodoc.pkg

• typeof
  pkgTypes
  > > > > [[S [[S S S] r1]] r1]
  > > > > liste des nouveaux types définis (non standard)
  
  pkgContent
  > > > > [[S r1] r1]
  > > > > contenu d'un pkg
  
  pkgKey
  > > > > [[S [[S S S S] r1]] r1]
  > > > > nom d'un pkg, mot-clé + commande + argument + commentaire de chaque mot-clé (typeof, var, defcom, ...)
  
  pkgFun
  > > > > [[S [S r1]] r1]
  > > > > nom du pkg, noms des fonctions
  
  


• var
  genfileslist
  > > > > "README" :: "INSTALL" :: "COPYING" :: "LICENCE" :: "AUTHORS" :: nil
  > > > > fichiers génériques
  
  typelist
  > > > > "struct" :: "typedef" :: nil
  > > > >
  
  keylist
  > > > > "typeof" :: "var" :: "defcom" :: "defcomvar" :: "proto" :: nil
  > > > > mots-clé
  
  


• defcom
  


• defcomvar
  


• proto
  _getRscSyntaxe
  > > > > fun [S] S
  > > > >
  
  

• PKGgetListFun
• PKGgetListGenFiles
• PKGgetListKey
• PKGgetListType
• PKGgetListType2
• PKGlistFun
• PKGlistGenFiles
• PKGlistKey
• PKGlistKey2
• PKGlistType
• PKGread
• PKGsearchComment
• PKGsearchFirstComment
• PKGverifyFilesFromDms
• PKGverifyFilesFromDmsLoad
• _PKGextractFilesFromDms
• _PKGextractFilesFromScript
• _PKGread
• _PKGread2
• _getRscSyntaxe
• apply_on_list
• cmpString
• cmpStringNot
• cmpStringi
• conc
• dividelist
• extractDefType
• extractNameFun
• extractNameKey
• extractNumberArg
• extractNumberArg2
• getExtension
• getFileWithoutExtension
• getPathFile
• getRscSyntaxe2
• is_string_in_list
• listcat
• mirror
• quicksort
• rdividelist
• rquicksort
• searchLastpoint
• search_InString

Fonction : cmpString
Arguments : 2

Fonction : cmpStringNot
Arguments : 2

Fonction : cmpStringi
Arguments : 2

Fonction : listcat
Arguments : 2

By Marc Barilley

Fonction : mirror
Arguments : 1

By Marc Barilley

Fonction : rdividelist
Arguments : 5

By Marc Barilley

Fonction : rquicksort
Arguments : 2

By Marc Barilley

Fonction : is_string_in_list
Arguments : 2

By Marc Barilley

Fonction : getPathFile
Arguments : 2

By Marc Barilley

Fonction : conc
Arguments : 2

by Sylvain Huet

Fonction : dividelist
Arguments : 3

by Sylvain Huet

Fonction : quicksort
Arguments : 2

by Sylvain Huet

Fonction : apply_on_list
Arguments : 3

by Sylvain Huet

Fonction : extractNameFun
Arguments : 1

Extrait le nom d'une fonction

Fonction : extractNameKey
Arguments : 5

Extrait un mot-clé : retourne le nom de la commande (ou de la variable), son argument (ou sa valeur
ou son type) et le commentaire associé s'il y a lieu
Fun [S] [S S S]

Fonction : extractNumberArg2
Arguments : 1

Extraction du nombre d'arguments d'une fonction

Fonction : extractNumberArg
Arguments : 1

Fonction : extractDefType
Arguments : 4

Extraction des structures et des constructeurs de types (respectivement 'struct' et 'typedef')

Fonction : searchLastpoint
Arguments : 1

Retourne la position du dernier point ( . ) d'une chaine

Fonction : getExtension
Arguments : 2

Vérifie l'extension d'un fichier. Retourne 1 si Ok, 0 autrement

Fonction : getFileWithoutExtension
Arguments : 1

Retourne le nom d'un fichier sans son extension

Fonction : search_InString
Arguments : 1

Retourne la liste des positions des '_' dans une chaine - fun [S] [I r1]

Fonction : getRscSyntaxe2
Arguments : 2

Fonction : _getRscSyntaxe
Arguments : 1

Retourne la valeur correspondant à une clé du format de sortie (TEXT, HTML, LATEX)

Fonction : PKGlistGenFiles
Arguments : 1

Retourne la chaine à écrire sur le fichier de sortie.
Elle contient la liste des fichiers génériques présents dans l'application (README, AUTHOR, ...)

Fonction : PKGgetListGenFiles
Arguments : 2

Retourne la liste des fichiers génériques présents dans l'application à documenter
fun [[S r1] S] [S r1]

Fonction : PKGgetListFun
Arguments : 1

Retourne la liste des noms de fonction contenus dans le package courant

Fonction : PKGgetListKey
Arguments : 1

Retourne la liste des mots-clé avec le nom de la commande (ou de la variable), son argument (ou sa valeur ou son type)
et son commentaire associé.
fun [[[S r1] r1]] [[S S S S] r1]

Fonction : PKGlistKey2
Arguments : 2

Fonction : PKGlistKey
Arguments : 2

Retourne la chaine des mots-clé à écrire dans le fichier de sortie

Fonction : PKGlistType
Arguments : 1

Retourne la chaine des types nouvellement définis (struct et typedef) à écrire dans le fichier de sortie

Fonction : PKGgetListType2
Arguments : 2

Fonction : PKGgetListType
Arguments : 2

Liste les types définis dans le package courant

Fonction : PKGlistFun
Arguments : 1

Retourne la liste des noms de fonctions à écrire dans le fichier de sortie

Fonction : PKGsearchFirstComment
Arguments : 1

Ecrit dans le fichier de sortie le(s) commentaire(s) en tête de fichier, s'il y a lieu

Fonction : PKGsearchComment
Arguments : 1

Retourne les commentaires associés à une fonction

Fonction : PKGread
Arguments : 2

Fonction : _PKGread2
Arguments : 1

Fonction : _PKGread
Arguments : 1

Ecriture du premier fichier de la documentation (index)

Fonction : _PKGextractFilesFromScript
Arguments : 1

Fonction : PKGverifyFilesFromDms
Arguments : 2

Fonction : PKGverifyFilesFromDmsLoad
Arguments : 1

Fonction : _PKGextractFilesFromDms
Arguments : 2