haddock - Dalam talian di Awan

JADUAL:

NAMA

haddock - alat dokumentasi untuk kod sumber Haskell beranotasi

SINOPSIS

haddock [pilihan] fail...

DESCRIPTION

Halaman manual ini mendokumentasikan secara ringkas haddock perintah. Dokumentasi yang luas adalah
tersedia dalam pelbagai format lain termasuk DVI, PostScript dan HTML; lihat di bawah.

fail ialah nama fail yang mengandungi modul sumber Haskell. Semua modul yang dinyatakan pada
baris arahan akan diproses bersama. Apabila satu modul merujuk kepada entiti dalam yang lain
modul sedang diproses, dokumentasi akan dipautkan terus kepada entiti tersebut.

Entiti yang tidak dapat ditemui, contohnya kerana mereka berada dalam modul yang tidak sedang
diproses sebagai sebahagian daripada kumpulan semasa, semata-mata tidak akan dipautkan dalam yang dihasilkan
dokumentasi. haddock akan mengeluarkan amaran yang menyenaraikan semua pengecam yang tidak dapat dilakukannya
azam.

Modul tidak boleh saling rekursif, seperti haddock tidak suka berenang
bulatan.

PILIHAN

Program mengikuti sintaks baris arahan GNU yang biasa, dengan pilihan panjang bermula dengan dua
sempang (`--'). Ringkasan pilihan disertakan di bawah. Untuk penerangan lengkap, lihat
dokumentasi yang lain.

-o DIR, --odir=DIR
direktori di mana untuk meletakkan fail output

-i FAIL, --read-interface=FAIL
membaca antara muka daripada FAIL.

-D FAIL, --dump-interface=FAIL
buang antara muka untuk modul ini ke dalam FAIL.

-l DIR, --lib=DIR
lokasi fail tambahan Haddock

-h, --html
Hasilkan dokumentasi dalam format HTML. Beberapa fail akan dijana ke dalam
direktori semasa (atau direktori yang ditentukan jika -o pilihan diberikan), termasuk
yang berikut:

index.html
Halaman peringkat atas dokumentasi: menyenaraikan modul yang tersedia, menggunakan
lekukan untuk mewakili hierarki jika modul adalah hierarki.

haddock.css
Lembaran gaya yang digunakan oleh HTML yang dihasilkan. Sila ubah suai ini kepada
menukar warna atau reka letak, atau tentukan lembaran gaya anda sendiri menggunakan
--css pilihan.

module.html
Halaman HTML untuk setiap modul.

doc-index.html, doc-index-XX.html
Indeks, berpecah kepada dua (fungsi/pembina dan jenis/kelas, seperti
ruang nama Haskell) dan seterusnya dibahagikan mengikut abjad.

--hoogle
output untuk Hoogle

--html-help=format
menghasilkan indeks dan jadual kandungan dalam format mshelp, mshelp2 atau devhelp (dengan -h)

--source-base=URL
Sertakan pautan ke fail sumber dalam dokumentasi yang dijana, di mana URL ialah
URL asas tempat fail sumber boleh ditemui.

-s url, --source-modul=URL
Sertakan pautan ke fail sumber dalam dokumentasi yang dijana, dengan URL ialah a
pautan kod sumber untuk setiap modul (menggunakan %{FILE} atau %{MODULE} vars).

--sumber-entiti=URL
Sertakan pautan ke fail sumber dalam dokumentasi yang dijana, dengan URL ialah a
pautan kod sumber untuk setiap entiti (menggunakan %{FILE}, %{MODULE} atau %{NAME} vars).

--comments-base=URL
URL untuk pautan ulasan pada kandungan dan halaman indeks.

--komen-modul=URL
URL untuk pautan ulasan untuk setiap modul (menggunakan %{MODULE} var).

--komen-entiti=URL
URL untuk pautan ulasan bagi setiap entiti (menggunakan %{FILE}, %{MODULE} atau %{NAME}
vars).

--css=FAIL
Gunakan CSS FAIL bukannya lembaran gaya lalai yang disertakan haddock untuk HTML
pengeluaran. Ia harus menentukan kelas tertentu: lihat helaian gaya lalai untuk mendapatkan butiran.

-p FAIL, --prolog=FAIL
Tentukan fail yang mengandungi teks prolog.

-t TITLE, --tajuk=TITLE
Penggunaan TITLE sebagai tajuk halaman untuk setiap halaman dalam dokumentasi. Ini akan
biasanya nama perpustakaan yang didokumenkan.

Tajuk hendaklah rentetan biasa (tiada markup please!).

-k NAMA, --pakej=NAMA
Nyatakan nama pakej (pilihan).

-n, --tiada-pendahuluan-tersirat
jangan anggap Prelude diimport

-d, --nyahpepijat
Dayakan output penyahpepijatan tambahan.

-?, - membantu
Paparkan bantuan.

-V, --versi
Versi paparan.

-v, --verbose
Pelaporan status bertele-tele.

--use-contents=URL
Gunakan halaman kandungan HTML yang dijana secara berasingan.

--gen-kandungan
Hasilkan kandungan HTML daripada antara muka yang ditentukan.

--use-index=URL
Gunakan indeks HTML yang dijana secara berasingan.

--gen-indeks
Hasilkan indeks HTML daripada antara muka yang ditentukan.

--abaikan-semua-eksport
Berkelakuan seolah-olah semua modul mempunyai atribut abaikan-eksport

--sorok=MODULE
Berkelakuan seolah-olah MODULE mempunyai sifat hide.

--use-package=PAKEJ
Modul yang sedang diproses bergantung pada PAKEJ.

Gunakan haddock dalam talian menggunakan perkhidmatan onworks.net