haddock - Online sa Cloud

PROGRAMA:

NAME

haddock - tool sa dokumentasyon para sa annotated na Haskell source code

SINOPSIS

hadok [pagpipilian] file...

DESCRIPTION

Ang manu-manong pahinang ito ay nagdodokumento ng maikling hadok utos. Ang malawak na dokumentasyon ay
magagamit sa iba't ibang mga format kabilang ang DVI, PostScript at HTML; tingnan sa ibaba.

file ay isang filename na naglalaman ng isang Haskell source module. Lahat ng mga module na tinukoy sa
Ang command line ay ipoproseso nang magkasama. Kapag ang isang module ay tumutukoy sa isang entity sa isa pa
module na pinoproseso, direktang magli-link ang dokumentasyon sa entity na iyon.

Mga entity na hindi mahanap, halimbawa dahil sila ay nasa isang module na hindi
naproseso bilang bahagi ng kasalukuyang batch, hindi na lang ma-hyperlink sa nabuo
dokumentasyon. hadok ay maglalabas ng mga babala na naglilista ng lahat ng mga pagkakakilanlan na hindi nito magagawa
lutasin.

Ang mga module ay hindi dapat magkaparehong recursive, bilang hadok hindi mahilig lumangoy
bilog.

Opsyon

Ang mga programa ay sumusunod sa karaniwang GNU command line syntax, na may mahabang opsyon na nagsisimula sa dalawa
mga gitling (`--'). Ang isang buod ng mga opsyon ay kasama sa ibaba. Para sa kumpletong paglalarawan, tingnan
ang iba pang dokumentasyon.

-o DIR, --odir=DIR
direktoryo kung saan ilalagay ang mga output file

-i FILE, --read-interface=FILE
basahin ang isang interface mula sa FILE.

-D FILE, --dump-interface=FILE
mag-dump ng interface para sa mga module na ito sa FILE.

-l DIR, --lib=DIR
lokasyon ng mga auxiliary file ng Haddock

-h, --html
Bumuo ng dokumentasyon sa HTML na format. Maraming mga file ang bubuo sa
kasalukuyang direktoryo (o ang tinukoy na direktoryo kung ang -o ang opsyon ay ibinigay), kasama ang
ang mga sumusunod:

index.html
Ang pahina sa tuktok na antas ng dokumentasyon: naglilista ng mga magagamit na module, gamit
indentation upang kumatawan sa hierarchy kung ang mga module ay hierarchical.

haddock.css
Ang stylesheet na ginamit ng nabuong HTML. Huwag mag-atubiling baguhin ito sa
baguhin ang mga kulay o layout, o kahit na tukuyin ang iyong sariling stylesheet gamit ang
--css pagpipilian.

module.html
Isang HTML na pahina para sa bawat module.

doc-index.html, doc-index-XX.html
Ang index, nahati sa dalawa (function/constructors at type/classes, as per
Haskell namespaces) at higit pang hatiin ayon sa alpabeto.

--hoogle
output para sa Hoogle

--html-help=format
gumawa ng index at talaan ng mga nilalaman sa mshelp, mshelp2 o devhelp na format (na may -h)

--source-base=URL
Isama ang mga link sa mga source file sa nabuong dokumentasyon, kung saan ang URL ay ang
base URL kung saan matatagpuan ang mga source file.

-s mga url, --source-module=URL
Isama ang mga link sa mga source file sa nabuong dokumentasyon, kung saan ang URL ay a
link ng source code para sa bawat module (gamit ang %{FILE} o %{MODULE} vars).

--source-entity=URL
Isama ang mga link sa mga source file sa nabuong dokumentasyon, kung saan ang URL ay a
link ng source code para sa bawat entity (gamit ang %{FILE}, %{MODULE} o %{NAME} vars).

--comments-base=URL
URL para sa link ng mga komento sa mga nilalaman at pahina ng index.

--comments-module=URL
URL para sa link ng mga komento para sa bawat module (gamit ang %{MODULE} var).

--comments-entity=URL
URL para sa link ng mga komento para sa bawat entity (gamit ang %{FILE}, %{MODULE} o %{NAME}
vars).

--css=FILE
Gamitin ang CSS FILE sa halip na ang default na stylesheet na kasama hadok para sa HTML
output. Dapat itong tukuyin ang ilang mga klase: tingnan ang default na stylesheet para sa mga detalye.

-p FILE, --prologue=FILE
Tukuyin ang isang file na naglalaman ng prologue text.

-t TITLE, --title=TITLE
paggamit TITLE bilang heading ng pahina para sa bawat pahina sa dokumentasyon. Ito ay
karaniwan ay ang pangalan ng library na dokumentado.

Ang pamagat ay dapat na isang plain string (walang markup mangyaring!).

-k NAME, --package=NAME
Tukuyin ang pangalan ng package (opsyonal).

-n, --walang-implicit-prelude
huwag ipagpalagay na ang Prelude ay na-import

-d, --debug
Paganahin ang karagdagang output sa pag-debug.

-?, - Tumulong
Ipakita ang tulong.

-V, --bersyon
Ipakita ang bersyon.

-v, --verbose
Verbose na pag-uulat sa katayuan.

--use-contents=URL
Gumamit ng isang hiwalay na nabuong pahina ng mga nilalaman ng HTML.

--gen-nilalaman
Bumuo ng HTML na nilalaman mula sa mga tinukoy na interface.

--use-index=URL
Gumamit ng hiwalay na nabuong HTML index.

--gen-index
Bumuo ng HTML index mula sa mga tinukoy na interface.

--ignore-all-exports
Kumilos na parang ang lahat ng mga module ay may attribute na ignore-exports

--itago=MODYUL
Behave as if MODYUL may katangiang itago.

--use-package=PACKAGE
Ang mga module na pinoproseso ay nakasalalay sa PACKAGE.

Gumamit ng haddock online gamit ang mga serbisyo ng onworks.net