ocamldoc.opt – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

ocamldoc – Der OCaml-Dokumentationsgenerator

ZUSAMMENFASSUNG

ocamldoc [ Optionen ] Dateinamen ...

BESCHREIBUNG

Der OCaml-Dokumentationsgenerator ocamldoc(1) Erzeugt Dokumentation aus Spezialdokumenten
Kommentare, die in Quelldateien eingebettet sind. Die von verwendeten Kommentare ocamldoc sind von der Form (** ...
*) und befolgen Sie das im beschriebene Format Die OCaml Benutzer manuell.

ocamldoc kann Dokumentation in verschiedenen Formaten erstellen: HTML, LaTeX, TeXinfo, Unix man
Seiten, und Punkt(1) Abhängigkeitsdiagramme. Darüber hinaus können Benutzer ihre eigenen benutzerdefinierten Generatoren hinzufügen.

Auf dieser Manpage verwenden wir das Wort Element sich auf einen der folgenden Teile eines beziehen
OCaml-Quelldatei: eine Typdeklaration, ein Wert, ein Modul, eine Ausnahme, ein Modultyp, a
Typkonstruktor, ein Datensatzfeld, eine Klasse, ein Klassentyp, eine Klassenmethode, ein Klassenwert oder
eine Klassenvererbungsklausel.

OPTIONAL

Die folgenden Befehlszeilenoptionen bestimmen das Format für die generierte Dokumentation
Erzeugt durch ocamldoc(1).

Optionen für Auswahl Möglichkeiten für das Ausgangssignal: Format
-html Generieren Sie Dokumentation im HTML-Standardformat. Die generierten HTML-Seiten werden gespeichert
im aktuellen Verzeichnis oder in dem mit dem angegebenen Verzeichnis -d Möglichkeit. Sie können
Passen Sie den Stil der generierten Seiten an, indem Sie die generierten Seiten bearbeiten style.css Datei,
oder indem Sie mithilfe der Option Ihr eigenes Stylesheet bereitstellen -CSS-Stil. Die Datei style.css
wird nicht generiert, wenn es bereits existiert.

-Latex Generieren Sie Dokumentation im LaTeX-Standardformat. Das generierte LaTeX-Dokument ist
in Datei gespeichert ocamldoc.out, oder in der mit dem angegebenen Datei -o Option. Die
Das Dokument verwendet die Stildatei ocamldoc.sty. Diese Datei wird bei Verwendung von generiert
-Latex Option, falls sie noch nicht vorhanden ist. Sie können diese Datei ändern, um sie anzupassen
den Stil Ihrer LaTeX-Dokumentation.

-texi Generieren Sie Dokumentation im TeXinfo-Standardformat. Das generierte LaTeX-Dokument ist
in Datei gespeichert ocamldoc.out, oder in der mit dem angegebenen Datei -o .

-Mann Generieren Sie die Dokumentation als eine Reihe von Unix-Manpages. Die generierten Seiten werden gespeichert
im aktuellen Verzeichnis oder in dem mit dem angegebenen Verzeichnis -d .

-Punkt Generieren Sie ein Abhängigkeitsdiagramm für die Toplevel-Module in einem geeigneten Format für
Anzeige und Verarbeitung durch Punkt(1). Das Punkt(1) Das Tool ist erhältlich bei
http://www.research.att.com/sw/tools/graphviz/. Die textliche Darstellung des
Das Diagramm wird in die Datei geschrieben ocamldoc.out, oder in die mit angegebene Datei -o
Möglichkeit. Benutzen Punkt ocamldoc.out um es anzuzeigen.

-g Datei
Laden Sie die angegebene Datei (deren Erweiterung normalerweise .cmo oder .cma ist) dynamisch
definiert einen benutzerdefinierten Dokumentationsgenerator. Wenn die angegebene Datei eine einfache ist und
existiert dann nicht im aktuellen Verzeichnis ocamldoc sucht im Brauch danach
Generators-Standardverzeichnis und in den mit dem angegebenen Verzeichnissen -i .

-customdir
Zeigt das Standardverzeichnis der benutzerdefinierten Generatoren an.

-i Verzeichnis
Fügen Sie das angegebene Verzeichnis zum Pfad hinzu, in dem nach benutzerdefinierten Generatoren gesucht werden soll.

Allgemein Optionen
-d dir Dateien im Verzeichnis generieren dir, und nicht das aktuelle Verzeichnis.

-Dump Datei
Geben Sie die gesammelten Informationen ab Datei. Diese Informationen können mit dem gelesen werden -Belastung
Option in einem nachfolgenden Aufruf von ocamldoc(1).

-verstecken Module
Blenden Sie die angegebenen vollständigen Modulnamen in der generierten Dokumentation aus. Module ist eine
Die Liste der vollständigen Modulnamen wird durch Kommas (,) ohne Leerzeichen getrennt. Für
Beispiel: Pervasive,M2.M3.

-inv-merge-ml-mli
Kehren Sie beim Zusammenführen die Priorität von Implementierungen und Schnittstellen um. Alle
Elemente in Implementierungsdateien bleiben erhalten, und die -m Die Option gibt an, welche Teile
der Kommentare in Schnittstellendateien werden mit den Kommentaren in der Implementierung zusammengeführt
Dateien.

-code behalten
Bewahren Sie immer den Quellcode für Werte, Methoden und Instanzvariablen auf
verfügbar. Der Quellcode bleibt immer erhalten, wenn eine .ml-Datei angegeben wird, ist aber von
Standardmäßig verworfen, wenn eine .mli-Datei angegeben wird. Mit dieser Option kann der Quellcode gespeichert werden
immer behalten.

-Belastung Datei
Informationen laden von Datei, das von produziert wurde ocamldoc -Dump. Mehrere
-Belastung Optionen können gegeben werden.

-m Fahnen
Geben Sie Zusammenführungsoptionen zwischen Schnittstellen und Implementierungen an. Fahnen kann einer sein oder
mehrere der folgenden Charaktere:

d Beschreibung zusammenführen

a @author zusammenführen

v @version zusammenführen

l @see zusammenführen

s @since zusammenführen

o merge @deprecated

p @param zusammenführen

e @raise zusammenführen

r @return zusammenführen

A alles zusammenführen

-no-custom-tags
Lassen Sie keine benutzerdefinierten @-Tags zu.

-kein Halt
Behalten Sie die nach dem platzierten Elemente bei (**/**) besonderer Kommentar.

-o Datei
Geben Sie die generierte Dokumentation aus Datei statt ocamldoc.out. Diese Option ist
nur in Verbindung mit dem sinnvoll -Latex, -texi, oder auch -Punkt Optionen.

-pp Befehl
Leiten Sie Quellen durch den Präprozessor Befehl.

-ppx Befehl
Leiten Sie den abstrakten Syntaxbaum durch den Präprozessor weiter Befehl.

-Sortieren Sortieren Sie die Liste der Module der obersten Ebene, bevor Sie die Dokumentation erstellen.

-Sterne Entfernen Sie Leerzeichen bis zum ersten Sternchen („*“) in jeder Kommentarzeile.

-t Titel
Verwenden Sie die Titel als Titel für die generierte Dokumentation.

-Einführung Datei
Verwenden Sie Inhalte von Datei as ocamldoc Text zur Verwendung als Einleitung (HTML, LaTeX und
Nur TeXinfo). Bei HTML wird die Datei zum Erstellen der gesamten Datei „index.html“ verwendet.

-v Ausführlicher Modus. Fortschrittsinformationen anzeigen.

-Ausführung
Versionsstring drucken und beenden.

-vnum Kurze Versionsnummer drucken und beenden.

-warn-Fehler
BEHANDELN ocamldoc Warnungen als Fehler.

-Warnungen ausblenden
Nicht drucken ocamldoc Warnungen.

-Hilfe or --help
Eine kurze Nutzungszusammenfassung anzeigen und beenden.

Typprüfung Optionen
ocamldoc(1) ruft den OCaml-Typprüfer auf, um Typinformationen zu erhalten. Die folgenden Optionen
Auswirkungen auf die Typprüfungsphase haben. Sie haben die gleiche Bedeutung wie für die
ocamlc(1) und okamlopt(1) Befehle.

-I Verzeichnis
Speichern Verzeichnis Suchen Sie in der Liste der Verzeichnisse nach kompilierten Schnittstellendateien (.cmi
Dateien).

-keine Etiketten
Ignorieren Sie nicht optionale Beschriftungen in Typen.

-rectypes
Beliebige rekursive Typen zulassen. (Siehe die -rectypes Option zu ocamlc(1).)

Optionen für Erzeugung HTML Seiten
Die folgenden Optionen gelten in Verbindung mit dem -html Option:

-all-params
Zeigt die vollständige Liste der Parameter für Funktionen und Methoden an.

-CSS-Stil Dateinamen
Verwenden Sie die Dateinamen als Cascading Style Sheet-Datei.

-colorize-code
Kolorieren Sie den in [ ] und \{[ ]\} eingeschlossenen OCaml-Code und verwenden Sie Farben zur Hervorhebung
Schlüsselwörter usw. Wenn die Codefragmente syntaktisch nicht korrekt sind, ist keine Farbe vorhanden
zugegeben.

-index-only
Generieren Sie nur Indexdateien.

-Kurzfunktoren
Verwenden Sie eine Kurzform, um Funktoren anzuzeigen: Modulen M : Funktor (A:Modul) -> Funktor
(B:Modul2) -> sig .. Ende wird angezeigt als Modulen M (A:Modul) (B:Modul2) : sig ..
Ende.

Optionen für Erzeugung Latex Dateien
Die folgenden Optionen gelten in Verbindung mit dem -Latex Option:

-Latex-Wert-Präfix Präfix
Geben Sie ein Präfix an, das für die Beschriftungen der Werte im generierten LaTeX-Dokument verwendet werden soll.
Das Standardpräfix ist die leere Zeichenfolge. Sie können auch die Optionen nutzen -Latex-Typ-
Präfix, -latex-Exception-Präfix, -latex-modul-präfix, -Latex-Modultyp-Präfix,
-Latex-Klassenpräfix, -Latex-Klassentyp-Präfix, -Latex-Attribut-Präfix und -Latex-
Methodenpräfix.

Diese Optionen sind nützlich, wenn Sie beispielsweise einen Typ und einen Wert mit haben
gleicher Name. Wenn Sie keine Präfixe angeben, beschwert sich LaTeX über die Multiplikation
definierte Etiketten.

-Latextitel n,Stil
Ordnen Sie die Stilnummer zu n zum angegebenen LaTeX-Schnittbefehl Stil, z.B
AbschnittorUnterabschnitt. (Nur LaTeX.) Dies ist nützlich, wenn Sie die generierten Dateien einschließen
Dokument in einem anderen LaTeX-Dokument auf einer bestimmten Abschnittsebene. Der Standard
Die Assoziation ist 1 für Abschnitt, 2 für Unterabschnitt, 3 für Unterunterabschnitt, 4 für
Absatz und 5 für Unterabsatz.

-keine Überschrift
Header in generierter Dokumentation unterdrücken.

-notoc Erstellen Sie kein Inhaltsverzeichnis.

-notrailer
Trailer in generierter Dokumentation unterdrücken.

-sepfiles
Generieren Sie eine .tex-Datei pro Toplevel-Modul anstelle der globalen ocamldoc.out
Datei.

Optionen für Erzeugung TeXinfo Dateien
Die folgenden Optionen gelten in Verbindung mit dem -texi Option:

-esc8 Escape-Zeichen mit Akzent in Infodateien.

-Info-Eintrag
Geben Sie den Infoverzeichniseintrag an.

-Info-Bereich
Geben Sie den Abschnitt des Infoverzeichnisses an.

-keine Überschrift
Header in generierter Dokumentation unterdrücken.

-noindex
Erstellen Sie keinen Index für Infodateien.

-notrailer
Trailer in generierter Dokumentation unterdrücken.

Optionen für Erzeugung Punkt Graphen
Die folgenden Optionen gelten in Verbindung mit dem -Punkt Option:

-Punktfarben Farben
Geben Sie die Farben an, die im generierten Punktcode verwendet werden sollen. Beim Generieren des Moduls
Abhängigkeiten, ocamldoc(1) verwendet je nach Modul unterschiedliche Farben
Verzeichnisse, in denen sie sich befinden. Beim Generieren von Typabhängigkeiten ocamldoc(1)
verwendet unterschiedliche Farben für Typen, abhängig von den Modulen, in denen sie sich befinden
definiert. Farben ist eine durch Kommas (,) getrennte Liste von Farbnamen, wie in
Rot, Blau, Grün. Die verfügbaren Farben sind diejenigen, die von unterstützt werden Punkt(1) Werkzeug.

-dot-include-all
Beziehen Sie alle Module in das ein Punkt(1) Ausgabe, nicht nur die im Befehl angegebenen Module
Zeile oder geladen mit der -Belastung .

-Punktreduzierung
Führen Sie eine transitive Reduktion des Abhängigkeitsgraphen durch, bevor Sie den Punkt ausgeben
Code. Dies kann nützlich sein, wenn es viele transitive Abhängigkeiten gibt, die Unordnung verursachen
der Graph.

-Punkttypen
Gibt einen Punktcode aus, der das Typabhängigkeitsdiagramm anstelle des Moduls beschreibt
Abhängigkeitsdiagramm.

Optionen für Erzeugung Mann Dateien
Die folgenden Optionen gelten in Verbindung mit dem -Mann Option:

-Mann-Mini
Generieren Sie Manpages stattdessen nur für Module, Modultypen, Klassen und Klassentypen
von Seiten für alle Elemente.

-man-Suffix Suffix
Legen Sie das Suffix fest, das für generierte MAN-Dateinamen verwendet wird. Der Standardwert ist o, wie in List.o.

-Mann-Abschnitt Abschnitt
Legen Sie die Abschnittsnummer fest, die für generierte MAN-Dateinamen verwendet wird. Der Standardwert ist 3.

Verwenden Sie ocamldoc.opt online über die Dienste von onworks.net