ocamldoc - En ligne dans le Cloud

PROGRAMME:

Nom

ocamldoc - Le générateur de documentation OCaml

SYNOPSIS

ocamldoc [ Options ] nom de fichier ...

DESCRIPTION

Le générateur de documentation OCaml ocamldoc(1) génère de la documentation à partir de
commentaires intégrés dans les fichiers source. Les commentaires utilisés par ocamldoc sont de la forme (** ...
*) et suivez le format décrit dans le Le OCaml utilisateur Manuel.

ocamldoc peut produire de la documentation dans divers formats : HTML, LaTeX, TeXinfo, Unix man
pages, et point(1) graphes de dépendance. De plus, les utilisateurs peuvent ajouter leurs propres générateurs personnalisés.

Dans cette page de manuel, nous utilisons le mot un élément faire référence à l'une des parties suivantes d'un
Fichier source OCaml : une déclaration de type, une valeur, un module, une exception, un type de module, un
constructeur de type, un champ d'enregistrement, une classe, un type de classe, une méthode de classe, une valeur de classe ou
une clause d'héritage de classe.

OPTIONS

Les options de ligne de commande suivantes déterminent le format de la documentation générée
généré par ocamldoc (1).

Options pour choose le sortie le format
-html Générez la documentation au format HTML par défaut. Les pages HTML générées sont stockées
dans le répertoire courant, ou dans le répertoire spécifié avec le -d option. Vous pouvez
personnaliser le style des pages générées en éditant les style.css fichier,
ou en fournissant votre propre feuille de style en utilisant l'option -style css. Le fichier style.css
n'est pas généré s'il existe déjà.

-latex Générez la documentation au format par défaut LaTeX. Le document LaTeX généré est
enregistré dans un fichier ocamldoc.out, ou dans le fichier spécifié avec le -o option. La
le document utilise le fichier de style ocamldoc.sty. Ce fichier est généré lors de l'utilisation du
-latex option, si elle n'existe pas déjà. Vous pouvez modifier ce fichier pour personnaliser
le style de votre documentation LaTeX.

-texi Générez la documentation au format par défaut de TeXinfo. Le document LaTeX généré est
enregistré dans un fichier ocamldoc.out, ou dans le fichier spécifié avec le -o option.

-homme Générez de la documentation sous la forme d'un ensemble de pages de manuel Unix. Les pages générées sont stockées
dans le répertoire courant, ou dans le répertoire spécifié avec le -d option.

-point Générer un graphe de dépendances pour les modules de niveau supérieur, dans un format adapté à
affichage et traitement par point(1). le point(1) l'outil est disponible à partir de
http://www.research.att.com/sw/tools/graphviz/. La représentation textuelle du
le graphique est écrit dans le fichier ocamldoc.out, ou au fichier spécifié avec le -o
option. Utiliser point ocamldoc.out pour l'afficher.

-g filet
Charge dynamiquement le fichier donné (dont l'extension est généralement .cmo ou .cma), qui
définit un générateur de documentation personnalisé. Si le fichier donné est simple et
n'existe pas dans le répertoire courant, alors ocamldoc le cherche dans la coutume
répertoire par défaut des générateurs, et dans les répertoires spécifiés avec le -i option.

-répertoire personnalisé
Affichez le répertoire par défaut des générateurs personnalisés.

-i annuaire
Ajoutez le répertoire donné au chemin où rechercher des générateurs personnalisés.

Général Options
-d dir Générer des fichiers dans le répertoire dir, plutôt que le répertoire courant.

-déverser filet
Transférer les informations collectées dans filet. Ces informations peuvent être lues avec le -charge
option dans une invocation ultérieure de ocamldoc (1).

-cacher modules
Cachez les noms de modules complets donnés dans la documentation générée. modules est une
liste des noms de modules complets sont séparés par des virgules (,), sans espaces. Pour
exemple: Omniprésents,M2.M3.

-inv-merge-ml-mli
Inversez la priorité des implémentations et des interfaces lors de la fusion. Tous
les éléments des dossiers de mise en œuvre sont conservés, et les -m option indique quelles parties
des commentaires dans les fichiers d'interface sont fusionnés avec les commentaires en implémentation
fichiers.

-garder-code
Conservez toujours le code source des valeurs, des méthodes et des variables d'instance, lorsque
disponible. Le code source est toujours conservé lorsqu'un fichier .ml est fourni, mais l'est par
par défaut rejeté lorsqu'un .mli est donné. Cette option permet au code source d'être
toujours gardé.

-charge filet
Charger les informations de filet, qui a été produit par ocamldoc -déverser. Nombreuses
-charge des options peuvent être données.

-m drapeaux
Spécifiez les options de fusion entre les interfaces et les implémentations. drapeaux peut être un ou
plusieurs des personnages suivants :

d fusionner la description

a fusionner @auteur

v fusionner @version

l fusionner @voir

s fusionner @depuis

o fusionner @obsolète

p fusionner @param

e fusionner @raise

r fusionner @return

A tout fusionner

-pas-de-balises-personnalisées
N'autorisez pas les balises @ personnalisées.

-pas d'arrêt
Gardez les éléments placés après le (**/**) commentaire spécial.

-o filet
Sortir la documentation générée vers filet au lieu de ocamldoc.out. Cette option est
n'a de sens qu'en conjonction avec le -latex, -texi, ou un -point options.

-pp commander
Canaliser les sources via le préprocesseur commander.

-ppx commander
Canaliser l'arbre de syntaxe abstraite via le préprocesseur commander.

-sorte Triez la liste des modules de niveau supérieur avant de générer la documentation.

-étoiles Supprimez les caractères vides jusqu'au premier astérisque (« * ») dans chaque ligne de commentaires.

-t titre
Utilisez titre comme titre de la documentation générée.

-introduction filet
Utiliser le contenu de filet as ocamldoc texte à utiliser comme introduction (HTML, LaTeX et
TeXinfo uniquement). Pour le HTML, le fichier est utilisé pour créer l'intégralité du fichier "index.html".

-v Mode verbeux. Afficher les informations de progression.

-version
Imprimer la chaîne de version et quitter.

-numéro virtuel Imprimer le numéro de version court et quitter.

-avertissement-erreur
Traiter ocamldoc les avertissements en tant qu'erreurs.

-masquer-avertissements
Ne pas imprimer ocamldoc avertissements.

-Aide or --Aidez-moi
Affichez un bref résumé d'utilisation et quittez.

Vérification de type Options
ocamldoc(1) appelle le vérificateur de type OCaml pour obtenir des informations de type. Les options suivantes
impact sur la phase de vérification de type. Ils ont le même sens que pour le
ocamlcde Géographie (1) et avec la ocamlopt(1) commandes.

-I annuaire
Ajouter annuaire dans la liste des répertoires rechercher les fichiers d'interface compilés (.cmi
des dossiers).

-pas d'étiquettes
Ignorez les étiquettes non facultatives dans les types.

-rectypes
Autoriser les types récursifs arbitraires. (Voir le -rectypes Option de ocamlc(1).)

Options pour générateur HTML pages
Les options suivantes s'appliquent conjointement avec le -html option:

-tous les paramètres
Affiche la liste complète des paramètres des fonctions et méthodes.

-style css nom de fichier
Utilisez nom de fichier comme fichier de feuille de style en cascade.

-coloriser-code
Colorisez le code OCaml entre [ ] et \{[ ]\}, en utilisant des couleurs pour souligner
mots-clés, etc. Si les fragments de code ne sont pas syntaxiquement corrects, aucune couleur n'est
ajouté.

-index-seulement
Générer uniquement des fichiers d'index.

-fonctions-courtes
Utilisez une forme courte pour afficher les foncteurs : module M : foncteur (A : Module) -> foncteur
(B : Module2) -> sig .. fin s'affiche comme module M (A : Module) (B : Module2) : sig ..
fin.

Options pour générateur Latex fichiers
Les options suivantes s'appliquent conjointement avec le -latex option:

-préfixe-valeur-latex préfixe
Donnez un préfixe à utiliser pour les étiquettes des valeurs dans le document LaTeX généré.
Le préfixe par défaut est la chaîne vide. Vous pouvez également utiliser les options -type-latex-
préfixe, -préfixe-exception-latex, -latex-module-préfixe, -préfixe-de-type-de-module-latex,
-préfixe-classe-latex, -préfixe-de-type-de-classe-latex, -préfixe-attribut-latex et -latex-
méthode-préfixe.

Ces options sont utiles lorsque vous avez, par exemple, un type et une valeur avec le
même nom. Si vous ne spécifiez pas de préfixes, LaTeX se plaindra de la multiplication
étiquettes définies.

-titre latex n, style
Numéro de style associé n à la commande de sectionnement LaTeX donnée Catégorie, par exemple
orsous-section. (LaTeX uniquement.) Ceci est utile lors de l'inclusion du
document dans un autre document LaTeX, à un niveau de sectionnement donné. Le défaut
l'association vaut 1 pour la section, 2 pour la sous-section, 3 pour la sous-section, 4 pour
paragraphe et 5 pour le sous-paragraphe.

-aucun en-tête
Supprimer l'en-tête dans la documentation générée.

-notoc Ne générez pas de table des matières.

-pas de remorque
Supprimer la bande-annonce dans la documentation générée.

-fichiers sep
Générer un fichier .tex par module de niveau supérieur, au lieu du global ocamldoc.out
fichier.

Options pour générateur TeXinfo fichiers
Les options suivantes s'appliquent conjointement avec le -texi option:

-esc8 Echappe les caractères accentués dans les fichiers Info.

-info-entrée
Spécifiez l'entrée du répertoire Info.

-section info
Spécifiez la section du répertoire Info.

-aucun en-tête
Supprimer l'en-tête dans la documentation générée.

-noindex
Ne créez pas d'index pour les fichiers Info.

-pas de remorque
Supprimer la bande-annonce dans la documentation générée.

Options pour générateur point graphiques
Les options suivantes s'appliquent conjointement avec le -point option:

-dot-couleurs les couleurs
Spécifiez les couleurs à utiliser dans le code à points généré. Lors de la génération du module
dépendances, ocamldoc(1) utilise des couleurs différentes pour les modules, selon le
répertoires dans lesquels ils résident. Lors de la génération de dépendances de types, ocamldoc(1)
utilise des couleurs différentes pour les types, selon les modules dans lesquels ils sont
Défini. les couleurs est une liste de noms de couleurs séparés par des virgules (,), comme dans
Rouge, Bleu, Vert. Les couleurs disponibles sont celles prises en charge par le point(1) outil.

-point-inclure-tout
Inclure tous les modules dans le point(1) sortie, pas seulement les modules donnés sur la commande
ligne ou chargé avec le -charge option.

-dot-réduire
Effectuer une réduction transitive du graphe de dépendance avant de sortir le point
code. Cela peut être utile s'il y a beaucoup de dépendances transitives qui encombrent
le graphique.

-types-points
Code de point de sortie décrivant le graphique de dépendance de type au lieu du module
graphique de dépendance.

Options pour générateur man fichiers
Les options suivantes s'appliquent conjointement avec le -homme option:

-homme-mini
Générer des pages de manuel uniquement pour les modules, les types de modules, les classes et les types de classes, à la place
de pages pour tous les éléments.

-man-suffixe suffixe
Définissez le suffixe utilisé pour les noms de fichiers man générés. La valeur par défaut est o, comme dans Liste.o.

-homme-section
Définissez le numéro de section utilisé pour les noms de fichiers man générés. La valeur par défaut est 3.

Utiliser ocamldoc en ligne à l'aide des services onworks.net