Schellfisch - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

haddock - Dokumentationstool für kommentierten Haskell-Quellcode

ZUSAMMENFASSUNG

Schellfisch [Optionen] Datei...

BESCHREIBUNG

Diese Handbuchseite dokumentiert kurz die Schellfisch Befehl. Umfangreiche Dokumentation ist
verfügbar in verschiedenen anderen Formaten, einschließlich DVI, PostScript und HTML; siehe unten.

Datei ist ein Dateiname, der ein Haskell-Quellmodul enthält. Alle Module, die auf der
Befehlszeile wird zusammen verarbeitet. Wenn ein Modul auf eine Entität in einem anderen verweist
Modul verarbeitet wird, wird die Dokumentation direkt mit dieser Entität verknüpft.

Entitäten, die nicht gefunden werden können, weil sie sich beispielsweise in einem Modul befinden, das nicht gefunden wird
als Teil des aktuellen Stapels verarbeitet, wird in der generierten Datei einfach nicht verlinkt
Dokumentation. Schellfisch gibt Warnungen aus, die alle Identifikatoren auflisten, die es nicht konnte
Entschlossenheit.

Die Module sollten sich nicht gegenseitig rekursiv sein, da Schellfisch schwimmt nicht gerne rein
Kreise.

OPTIONAL

Die Programme folgen der üblichen GNU-Befehlszeilensyntax, mit langen Optionen, die mit zwei beginnen
Bindestriche (`--'). Nachfolgend finden Sie eine Zusammenfassung der Optionen. Eine vollständige Beschreibung finden Sie unter
die andere Dokumentation.

-o DIR, --odir=DIR
Verzeichnis, in das die Ausgabedateien abgelegt werden sollen

-i FILE, --read-interface=FILE
eine Schnittstelle auslesen von FILE.

-D FILE, --dump-interface=FILE
Dump eine Schnittstelle für diese Module in FILE.

-l DIR, --lib=DIR
Speicherort der Hilfsdateien von Haddock

-h, --html
Erstellen Sie eine Dokumentation im HTML-Format. Mehrere Dateien werden in die
aktuelles Verzeichnis (oder das angegebene Verzeichnis, wenn die -o Option ist gegeben), einschließlich
die folgende:

index.html
Die Top-Level-Seite der Dokumentation: listet die verfügbaren Module auf, unter Verwendung von
Einrückung zur Darstellung der Hierarchie, wenn die Module hierarchisch sind.

Schellfisch.css
Das vom generierten HTML verwendete Stylesheet. Fühlen Sie sich frei, dies zu ändern zu
Ändern Sie die Farben oder das Layout oder geben Sie sogar Ihr eigenes Stylesheet mit dem . an
--css .

modul.html
Eine HTML-Seite für jedes Modul.

doc-index.html, doc-index-XX.html
Der Index, aufgeteilt in zwei (Funktionen/Konstruktoren und Typen/Klassen, gemäß
Haskell-Namespaces) und weiter alphabetisch aufteilen.

--hoogle
Ausgabe für Hoogle

--html-help=Format
Index und Inhaltsverzeichnis im mshelp-, mshelp2- oder devhelp-Format erstellen (mit -h)

--source-base=URL
Fügen Sie Links zu den Quelldateien in die generierte Dokumentation ein, wobei URL die ist
Basis-URL, unter der die Quelldateien zu finden sind.

-s URL, --source-module=URL
Fügen Sie Links zu den Quelldateien in die generierte Dokumentation ein, wobei URL a . ist
Quellcode-Link für jedes Modul (unter Verwendung der Variablen %{FILE} oder %{MODULE}).

--source-entity=URL
Fügen Sie Links zu den Quelldateien in die generierte Dokumentation ein, wobei URL a . ist
Quellcode-Link für jede Entität (unter Verwendung der Variablen %{FILE}, %{MODULE} oder %{NAME}).

--comments-base=URL
URL für einen Kommentarlink zu den Inhalts- und Indexseiten.

--comments-module=URL
URL für einen Kommentarlink für jedes Modul (unter Verwendung der %{MODULE}-Var).

--comments-entity=URL
URL für einen Kommentarlink für jede Entität (unter Verwendung von %{FILE}, %{MODULE} oder %{NAME}
vars).

--css=FILE
Verwenden Sie das CSS FILE anstelle des mitgelieferten Standard-Stylesheets Schellfisch für HTML
Ausgang. Es sollte bestimmte Klassen angeben: Einzelheiten finden Sie im Standard-Stylesheet.

-p FILE, --prolog=FILE
Geben Sie eine Datei mit Prologtext an.

-t TITEL, --title=TITEL
Verwenden Sie die TITEL als Seitenüberschrift für jede Seite in der Dokumentation. Dieser Wille
normalerweise der Name der Bibliothek sein, die dokumentiert wird.

Der Titel sollte eine einfache Zeichenfolge sein (bitte kein Markup!).

-k NAME/FUNKTION, --Paket=NAME/FUNKTION
Geben Sie den Paketnamen an (optional).

-n, --no-implicit-prelude
Gehen Sie nicht davon aus, dass Prelude importiert wird

-d, --debuggen
Aktivieren Sie zusätzliche Debugging-Ausgaben.

-?, --help
Hilfe anzeigen.

-V, --Version
Version anzeigen.

-v, - ausführlich
Ausführliche Statusberichterstattung.

--use-contents=URL
Verwenden Sie eine separat generierte HTML-Inhaltsseite.

--gen-Inhalte
Generieren Sie einen HTML-Inhalt aus angegebenen Schnittstellen.

--use-index=URL
Verwenden Sie einen separat generierten HTML-Index.

--gen-index
Generieren Sie einen HTML-Index aus angegebenen Schnittstellen.

--ignore-all-exports
Verhalten Sie sich so, als ob alle Module das Attribut ignore-exports haben

--hide=MODULE
Verhalten Sie sich so, als ob MODULE hat das Hide-Attribut.

--use-package=PAKET
Die bearbeiteten Module sind abhängig von PAKET.

Verwenden Sie Schellfisch online mit den onworks.net-Diensten