plamiak — online w chmurze

PROGRAM:

IMIĘ

plamiak - narzędzie do dokumentacji kodu źródłowego Haskella z adnotacjami

STRESZCZENIE

plamiak [Opcje] filet...

OPIS

Ta strona podręcznika opisuje pokrótce plamiak Komenda. Obszerna dokumentacja jest
dostępne w różnych innych formatach, w tym DVI, PostScript i HTML; patrz poniżej.

filet to nazwa pliku zawierającego moduł źródłowy Haskell. Wszystkie moduły określone na
wiersz poleceń będą przetwarzane razem. Gdy jeden moduł odnosi się do jednostki w innym
moduł jest przetwarzany, dokumentacja będzie powiązana bezpośrednio z tym podmiotem.

Podmioty, których nie można znaleźć, na przykład dlatego, że znajdują się w module, którego nie ma
przetwarzane w ramach bieżącej partii, po prostu nie będą wyświetlane hiperłącza w wygenerowanym pliku
dokumentacja. plamiak wyemituje ostrzeżenia zawierające listę wszystkich identyfikatorów, których nie mógł
rozwiązać.

Moduły nie powinny być wzajemnie rekurencyjne, ponieważ plamiak nie lubi się kąpać
koła.

OPCJE

Programy działają zgodnie ze zwykłą składnią wiersza poleceń GNU, z długimi opcjami zaczynającymi się od dwóch
kreski (`--'). Podsumowanie opcji znajduje się poniżej. Aby uzyskać pełny opis, zob
druga dokumentacja.

-o DIR, --odir=DIR
katalog, w którym należy umieścić pliki wyjściowe

-i FILE, --interfejs odczytu=FILE
przeczytaj interfejs z FILE.

-D FILE, --dump-interfejs=FILE
zrzuć interfejs dla tych modułów FILE.

-l DIR, --lib=DIR
lokalizacja plików pomocniczych Haddocka

-h, --html
Generuj dokumentację w formacie HTML. W pliku . zostanie wygenerowanych kilka plików
bieżący katalog (lub określony katalog, jeśli -o podana jest opcja), w tym
następujące brzmienie:

index.html
Strona najwyższego poziomu dokumentacji: zawiera listę dostępnych modułów za pomocą
wcięcie reprezentujące hierarchię, jeśli moduły są hierarchiczne.

plamiak.css
Arkusz stylów używany przez wygenerowany kod HTML. Możesz to zmienić na
zmienić kolory lub układ, a nawet określić własny arkusz stylów za pomocą
--css opcja.

moduł.html
Strona HTML dla każdego modułu.

doc-index.html, doc-index-XX.html
Indeks podzielony na dwie części (funkcje/konstruktory i typy/klasy, zgodnie z
przestrzenie nazw Haskell) i dalej dzielone alfabetycznie.

--hoogle
dane wyjściowe dla Hoogle

--html-pomoc=format
utwórz indeks i spis treści w formacie mshelp, mshelp2 lub devhelp (z -h)

--źródło-podstawy=URL
Dołącz łącza do plików źródłowych w wygenerowanej dokumentacji, gdzie adres URL to
podstawowy adres URL, pod którym można znaleźć pliki źródłowe.

-s adres URL, --moduł-źródłowy=URL
Dołącz łącza do plików źródłowych w wygenerowanej dokumentacji, gdzie adres URL to a
link do kodu źródłowego dla każdego modułu (przy użyciu zmiennych %{FILE} lub %{MODULE}).

--jednostka-źródłowa=URL
Dołącz łącza do plików źródłowych w wygenerowanej dokumentacji, gdzie adres URL to a
łącze do kodu źródłowego dla każdej jednostki (przy użyciu zmiennych %{FILE}, %{MODULE} lub %{NAME}).

--komentarze-baza=URL
Adres URL łącza do komentarzy w treści i na stronach indeksu.

--moduł-komentarzy=URL
Adres URL linku do komentarzy dla każdego modułu (przy użyciu zmiennej %{MODULE}).

--komentarze-jednostka=URL
Adres URL linku do komentarzy dla każdego elementu (przy użyciu %{FILE}, %{MODULE} lub %{NAME}
var).

--css=FILE
Użyj CSS FILE zamiast domyślnego arkusza stylów dołączonego do zestawu plamiak dla HTML-a
wyjście. Powinien określać pewne klasy: szczegóły znajdziesz w domyślnym arkuszu stylów.

-p FILE, --prolog=FILE
Określ plik zawierający tekst prologu.

-t TYTUŁ, --tytuł=TYTUŁ
Zastosowanie TYTUŁ jako nagłówek każdej strony w dokumentacji. To będzie
zwykle jest to nazwa dokumentowanej biblioteki.

Tytuł powinien być zwykłym ciągiem znaków (proszę bez żadnych znaczników!).

-k IMIĘ, --pakiet=IMIĘ
Określ nazwę pakietu (opcjonalnie).

-n, --no-implicit-prelude
nie zakładaj, że Prelude jest importowany

-d, --odpluskwić
Włącz dodatkowe wyjście debugowania.

-?, --help
Wyświetl pomoc.

-V, --wersja
Wersja wyświetlacza.

-v, --gadatliwy
Szczegółowe raportowanie stanu.

--use-content=URL
Użyj oddzielnie wygenerowanej strony zawartości HTML.

--gen-zawartość
Wygeneruj zawartość HTML z określonych interfejsów.

--use-index=URL
Użyj oddzielnie wygenerowanego indeksu HTML.

--gen-indeks
Wygeneruj indeks HTML z określonych interfejsów.

--ignore-all-export
Zachowuj się tak, jakby wszystkie moduły miały atrybut ignorowania eksportu

--ukryj=MODUŁ
Zachowuj się jak gdyby MODUŁ ma atrybut ukrywania.

--use-package=PAKIET
Przetwarzane moduły zależą od PAKIET.

Korzystaj z plamiaka online, korzystając z usług onworks.net