pasdoc - En ligne dans le Cloud

PROGRAMME:

Nom

PasDoc - outil de documentation pour le code source Pascal

SYNOPSIS

pasdoc [Options] [fichiers]

DESCRIPTION

PasDoc 0.14.0 [2015-08-09|FPC 2.6.4|Linux|64] Générateur de documentation pour les sources Pascal

C'est un logiciel libre ; voir la source pour les conditions de copie. Il n'y a AUCUNE garantie ; ne pas
même pour la QUALITÉ MARCHANDE ou l'ADAPTATION À UN USAGE PARTICULIER.

Valide Options sont:
- ?, --Aidez-moi
Afficher cette aide

--version
Afficher la version pasdoc (et les informations associées)

-v, --verbosité
Définir la verbosité du journal (0-6) [2]

-D, --définir
Définir le conditionnel

-R, --la description
Lire la description de ce fichier

-d, --conditions
Lire les conditions de ce fichier

-I, --comprendre
Inclut le chemin de recherche

-S, --la source
Lire les noms de fichiers source à partir du fichier

--html-help-contenu
Lire le contenu de HtmlHelp à partir du fichier

-F, --bas de page
Inclure le fichier comme pied de page pour la sortie HTML

-H, --entête
Inclure le fichier comme en-tête pour la sortie HTML

-N, --Nom
Nom de la documentation

-T, --Titre
Titre de la documentation

-O, --format
Format de sortie : html, simplexml, latex, latex2rtf ou htmlhelp

-E, --output
Chemin de sortie

-X, --exclure-générateur
Exclure les informations sur le générateur

--include-heure-de-création
Inclure le temps de création dans les documents

-L, --Langue
Langue de sortie. Les langues valides sont : ba : bosniaque (page de code 1250) br.1252 :
Brésilien (page de code 1252) br.utf8 : brésilien (page de code UTF-8) bg : bulgare
(page de code UTF-8) ct : catalan gb2312 : chinois (simple, gb2312) hr : croate dk :
danois nl : néerlandais en : anglais fr : français (iso-8859-15) fr.utf8 : français (UTF-8) de :
ID allemand : indonésien it : italien jv : javanais pl.cp1250 : polonais (page de code CP1250)
pl.iso-8859-2 : polonais (page de code ISO 8859-2) ru.1251 : russe (page de code 1251)
ru.utf8 : russe (page de code UTF-8) ru.866 : russe (page de code 866) ru.koi8r : russe
(KOI-8) sk : slovaque (page de code 1250) es : espagnol se : suédois hu.1250 : hongrois
(Codepage 1250) cz : tchèque (Codepage 1250) cz.iso-8859-2 : tchèque (Codepage ISO
8859-2)

--star uniquement
Analyser uniquement les commentaires de style {**, (*** et //**)

--marqueur
Analyser uniquement { , (* et // commentaires. Remplace l'étoile uniquement
option, qui est un raccourci pour '--marker=**'

--marker-facultatif
Ne nécessitent pas les marqueurs donnés dans --marqueur mais supprimez-les du commentaire si
ils existent.

--ignore-en-tête
Ignorer le début personnages dans les commentaires.

--noms de fichiers numériques
Le générateur html crée des noms de fichiers numériques

-M, --visible-membres
Inclure / Exclure les membres du groupe par visibilité

--write-use-list
Mettre la liste des utilisations en sortie

--graphviz-use
Ecrivez un fichier GVUses.dot qui peut être utilisé pour le programme `dot` de GraphViz vers
générer un graphe de dépendance unitaire

--graphviz-classes
Ecrivez un fichier GVClasses.dot qui peut être utilisé pour le programme `dot` de GraphViz vers
générer un graphique de hiérarchie de classes

--link-gv-use
Ajouter un lien vers un GVUses. fichier généré par le programme `dot` où
est toute extension que `dot` peut générer (par exemple jpg). (actuellement uniquement pour HTML
production)

--link-gv-classes
Ajouter un lien vers un GVClasses. fichier généré par le programme `dot` où
est toute extension que `dot` peut générer (par exemple jpg). (actuellement uniquement pour
sortie HTML)

--abréviations
Fichier d'abréviation, le format est "[nom] valeur", la valeur est coupée, les lignes qui ne
commencent par '[' (ou un espace avant cela) sont ignorés

--correction orthographique
Activer la vérification orthographique par Aspell, spécifier la langue par le --Langue option

--vérification orthographique-ignorer-les-mots
Lors de la vérification orthographique, ignorez les mots de ce fichier. Le fichier doit contenir un
mot sur chaque ligne

--un sort
Obsolète, utilisez --correction orthographique. Activer la vérification orthographique par Aspell, en donnant la langue comme
paramètre

--cache-dir
Répertoire de cache pour les fichiers analysés (par défaut non défini)

--link-look
Comment les liens sont affichés dans la documentation : "default" (afficher le nom complet du lien,
comme spécifié par @link), "full" (affichez le nom complet du lien et essayez de faire en sorte que chaque
une partie de celui-ci un lien), ou "dépouillé" (afficher uniquement la dernière partie du lien)

--lien-complet
Nom obsolète pour --link-look=plein

--css Fichier CSS pour les fichiers HTML (copié dans l'arborescence de sortie)

--auto-abstrait
Si défini, pasdoc fera automatiquement une description abstraite de chaque élément du
première phrase de la description de cet article

--use-tipue-search
Utiliser le moteur de recherche tipue dans la sortie HTML

--sorte Spécifie quels groupes d'éléments sont triés (le reste est présenté dans le même ordre
ils ont été déclarés dans vos fichiers sources)

--introduction
Le nom d'un fichier texte avec des documents d'introduction pour le projet

--conclusion
Le nom d'un fichier texte avec des matériaux de conclusion pour le projet

--tête en latex
Le nom d'un fichier texte qui comprend des lignes à insérer dans le préambule d'un
fichier LaTeX

--visibilité-implicite
Comment pasdoc doit gérer les membres de la classe dans la visibilité par défaut de la classe

--pas de macro
Désactiver la prise en charge des macros FPC

--auto-lien
Créer automatiquement des liens, sans avoir besoin d'utiliser explicitement les balises @link

--auto-link-exclure
Même quand --auto-lien est activé, ne créez jamais automatiquement des liens vers des identifiants dans le
fichier spécifié. Le fichier doit contenir un identifiant sur chaque ligne

--hiérarchie-de-classes-externes
Fichier définissant la hiérarchie des classes non incluses dans votre code source, pour en savoir plus
diagrammes d'arbres de classes complets

PasDoc 0.14.0 [2015-08-09|FPC 2.6.4|Linux|6 août 2015 PASDOC(1)

Utilisez pasdoc en ligne en utilisant les services onworks.net