Il s'agit de la commande haddock qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
haddock - outil de documentation pour le code source Haskell annoté
SYNOPSIS
aiglefin [Options] filet
DESCRIPTION
Cette page de manuel documente brièvement les aiglefin commander. Une documentation abondante est
disponible dans divers autres formats, notamment DVI, PostScript et HTML ; voir ci-dessous.
filet est un nom de fichier contenant un module source Haskell. Tous les modules spécifiés sur le
la ligne de commande sera traitée ensemble. Lorsqu'un module fait référence à une entité dans un autre
module en cours de traitement, la documentation sera directement liée à cette entité.
Entités introuvables, par exemple parce qu'elles se trouvent dans un module qui n'est pas
traité dans le cadre du lot actuel, ne sera tout simplement pas lié par hypertexte dans le fichier généré
Documentation. aiglefin émettra des avertissements listant tous les identifiants qu'il n'a pas pu
résoudre.
Les modules ne doivent pas être mutuellement récursifs, car aiglefin n'aime pas nager
cercles
OPTIONS
Les programmes suivent la syntaxe habituelle de la ligne de commande GNU, avec de longues options commençant par deux
tirets (`--'). Un résumé des options est inclus ci-dessous. Pour une description complète, voir
les autres documents.
-o DIR, --odir=DIR
répertoire dans lequel mettre les fichiers de sortie
-i DOSSIER, --read-interface=DOSSIER
lire une interface de DOSSIER.
-D DOSSIER, --dump-interface=DOSSIER
dump une interface pour ces modules dans DOSSIER.
-l DIR, --lib=DIR
emplacement des fichiers auxiliaires de Haddock
-h, --html
Générez de la documentation au format HTML. Plusieurs fichiers seront générés dans le
répertoire courant (ou le répertoire spécifié si le -o option est donnée), y compris
ce qui suit:
index.html
La page de niveau supérieur de la documentation : liste les modules disponibles, en utilisant
indentation pour représenter la hiérarchie si les modules sont hiérarchiques.
aiglefin.css
La feuille de style utilisée par le HTML généré. N'hésitez pas à le modifier pour
changer les couleurs ou la mise en page, ou même spécifier votre propre feuille de style en utilisant le
--css option.
module.html
Une page HTML pour chaque module.
doc-index.html, doc-index-XX.html
L'index, divisé en deux (fonctions/constructeurs et types/classes, selon
espaces de noms Haskell) et ensuite divisés par ordre alphabétique.
--hoogle
sortie pour Hoogle
--html-aide=le format
produire un index et une table des matières au format mshelp, mshelp2 ou devhelp (avec -h)
--source-base=URL
Incluez des liens vers les fichiers sources dans la documentation générée, où URL est le
URL de base où se trouvent les fichiers sources.
-s URL, --source-module=URL
Incluez des liens vers les fichiers sources dans la documentation générée, où URL est un
lien du code source pour chaque module (en utilisant les vars %{FILE} ou %{MODULE}).
--source-entité=URL
Incluez des liens vers les fichiers sources dans la documentation générée, où URL est un
lien du code source pour chaque entité (en utilisant les vars %{FILE}, %{MODULE} ou %{NAME}).
--commentaires-base=URL
URL pour un lien de commentaires sur les pages de contenu et d'index.
--commentaires-module=URL
URL d'un lien de commentaires pour chaque module (en utilisant la var %{MODULE}).
--commentaires-entity=URL
URL pour un lien de commentaires pour chaque entité (en utilisant le %{FILE}, %{MODULE} ou %{NAME}
var).
--css=DOSSIER
Utiliser le CSS DOSSIER au lieu de la feuille de style par défaut fournie avec aiglefin pour HTML
sortir. Il doit spécifier certaines classes : voir la feuille de style par défaut pour plus de détails.
-p DOSSIER, --prologue=DOSSIER
Spécifiez un fichier contenant le texte du prologue.
-t TITRE, --titre=TITRE
Utilisez TITRE comme en-tête de chaque page de la documentation. Cette volonté
normalement être le nom de la bibliothèque documentée.
Le titre doit être une chaîne simple (pas de balisage s'il vous plaît !).
-k Nom, --paquet=Nom
Spécifiez le nom du package (facultatif).
-n, --no-implicit-prélude
ne supposez pas que Prelude est importé
-d, --déboguer
Activer la sortie de débogage supplémentaire.
-?, --Aidez-moi
Afficher l'aide.
-V, --version
Afficher la version.
-v, --verbeux
Rapport d'état détaillé.
--use-content=URL
Utilisez une page de contenu HTML générée séparément.
--gen-contenu
Générer un contenu HTML à partir d'interfaces spécifiées.
--use-index=URL
Utilisez un index HTML généré séparément.
--gen-index
Générer un index HTML à partir des interfaces spécifiées.
--ignore-toutes-exportations
Se comporter comme si tous les modules avaient l'attribut ignore-exports
--cacher=MODULE
Comportez-vous comme si MODULE a l'attribut hide.
--use-paquet=RANGEMENT
Les modules en cours de traitement dépendent de RANGEMENT.
Utilisez l'aiglefin en ligne à l'aide des services onworks.net
