schelvis - Online in de cloud

PROGRAMMA:

NAAM

schelvis - documentatietool voor geannoteerde Haskell-broncode

KORTE INHOUD

schelvis [opties] filet...

PRODUCTBESCHRIJVING

Deze handleiding documenteert in het kort de: schelvis opdracht. Uitgebreide documentatie is
beschikbaar in verschillende andere formaten, waaronder DVI, PostScript en HTML; zie onder.

filet is een bestandsnaam die een Haskell-bronmodule bevat. Alle modules gespecificeerd op de
opdrachtregel worden samen verwerkt. Wanneer een module verwijst naar een entiteit in een andere?
module wordt verwerkt, wordt de documentatie rechtstreeks naar die entiteit gelinkt.

Entiteiten die niet gevonden kunnen worden, bijvoorbeeld omdat ze in een module zitten die niet wordt
verwerkt als onderdeel van de huidige batch, wordt eenvoudigweg niet gehyperlinkt in de gegenereerde
documentatie. schelvis zal waarschuwingen uitzenden met alle identifiers die het niet kon
op te lossen.

De modules mogen niet wederzijds recursief zijn, zoals: schelvis houdt er niet van om in te zwemmen
kringen.

OPTIES

De programma's volgen de gebruikelijke GNU-opdrachtregelsyntaxis, met lange opties die beginnen met twee
streepjes (`--'). Hieronder vindt u een overzicht van de mogelijkheden. Voor een volledige beschrijving, zie
de andere documentatie.

-o DIR, --odir=DIR
map waarin de uitvoerbestanden moeten worden geplaatst

-i FILE, --lees-interface=FILE
lees een interface van FILE.

-D FILE, --dump-interface=FILE
dump een interface voor deze modules in FILE.

-l DIR, --lib=DIR
locatie van de hulpbestanden van Haddock

-h, --html
Genereer documentatie in HTML-formaat. Er worden verschillende bestanden gegenereerd in de
huidige map (of de opgegeven map als de -o optie wordt gegeven), inclusief:
het volgende:

index.html
De pagina op het hoogste niveau van de documentatie: geeft een overzicht van de beschikbare modules, met behulp van
inspringen om de hiërarchie weer te geven als de modules hiërarchisch zijn.

schelvis.css
De stylesheet die wordt gebruikt door de gegenereerde HTML. Voel je vrij om dit aan te passen naar:
verander de kleuren of lay-out, of specificeer zelfs uw eigen stylesheet met behulp van de
--css optie.

module.html
Een HTML-pagina voor elke module.

doc-index.html, doc-index-XX.html
De index, opgesplitst in twee (functies/constructors en types/klassen, volgens
Haskell-naamruimten) en verder alfabetisch gesplitst.

--hoogle
uitgang voor Hoogle

--html-help=formaat
maak index en inhoudsopgave in mshelp, mshelp2 of devhelp formaat (met -h)

--bron-basis=URL
Voeg koppelingen toe naar de bronbestanden in de gegenereerde documentatie, waarbij URL de . is
basis-URL waar de bronbestanden te vinden zijn.

-s URL's, --bron-module=URL
Voeg links naar de bronbestanden toe aan de gegenereerde documentatie, waarbij URL a . is
broncodelink voor elke module (met behulp van de %{FILE} of %{MODULE} vars).

--source-entiteit=URL
Voeg links naar de bronbestanden toe aan de gegenereerde documentatie, waarbij URL a . is
broncodelink voor elke entiteit (met behulp van de %{FILE}, %{MODULE} of %{NAME} vars).

--comments-base=URL
URL voor een reactielink op de inhouds- en indexpagina's.

--opmerkingen-module=URL
URL voor een reactielink voor elke module (met behulp van de %{MODULE} var).

--opmerkingen-entiteit=URL
URL voor een reactielink voor elke entiteit (met behulp van de %{FILE}, %{MODULE} of %{NAME}
var).

--css=FILE
Gebruik de CSS FILE in plaats van de standaard stylesheet die wordt geleverd met schelvis voor HTML
uitvoer. Het zou bepaalde klassen moeten specificeren: zie de standaard stylesheet voor details.

-p FILE, --proloog=FILE
Geef een bestand op dat proloogtekst bevat.

-t TITEL, --titel=TITEL
Te gebruiken TITEL als de paginakop voor elke pagina in de documentatie. Dit zal
normaal gesproken de naam zijn van de bibliotheek die wordt gedocumenteerd.

De titel moet een gewone tekenreeks zijn (geen opmaak alstublieft!).

-k NAAM, --pakket=NAAM
Geef de pakketnaam op (optioneel).

-n, --geen-impliciete-prelude
ga er niet vanuit dat Prelude is geïmporteerd

-d, --debuggen
Schakel extra foutopsporingsuitvoer in.

-?, --help
Hulp weergeven.

-V, --versie
Versie weergeven.

-v, --uitgebreid
Uitgebreide statusrapportage.

--gebruik-inhoud=URL
Gebruik een afzonderlijk gegenereerde HTML-inhoudspagina.

--gen-inhoud
Genereer een HTML-inhoud van gespecificeerde interfaces.

--gebruik-index=URL
Gebruik een afzonderlijk gegenereerde HTML-index.

--gen-index
Genereer een HTML-index van gespecificeerde interfaces.

--negeer-alle-exports
Gedraag je alsof alle modules het kenmerk negeren-exports hebben

--verbergen=MODULE
Gedraag je alsof MODULE heeft het kenmerk verbergen.

--gebruik-pakket=PAKKET
De modules die worden verwerkt, zijn afhankelijk van: PAKKET.

Gebruik schelvis online met onworks.net-services