haddock - Online di Cloud

PROGRAM:

NAMA

haddock - alat dokumentasi untuk kode sumber Haskell beranotasi

RINGKASAN

haddock [Pilihan] fillet...

DESKRIPSI

Halaman manual ini mendokumentasikan secara singkat haddock memerintah. Dokumentasi yang luas adalah
tersedia dalam berbagai format lain termasuk DVI, PostScript dan HTML; Lihat di bawah.

fillet adalah nama file yang berisi modul sumber Haskell. Semua modul yang ditentukan pada
baris perintah akan diproses bersama-sama. Ketika satu modul merujuk ke entitas lain
modul sedang diproses, dokumentasi akan terhubung langsung ke entitas itu.

Entitas yang tidak dapat ditemukan, misalnya karena berada dalam modul yang tidak ada
diproses sebagai bagian dari batch saat ini, sama sekali tidak akan di-hyperlink di yang dihasilkan
dokumentasi. haddock akan mengeluarkan peringatan yang mencantumkan semua pengidentifikasi yang tidak bisa
menyelesaikan.

Modul tidak boleh saling rekursif, karena haddock tidak suka berenang
lingkaran.

PILIHAN

Program mengikuti sintaks baris perintah GNU biasa, dengan opsi panjang dimulai dengan dua
tanda hubung (`--'). Ringkasan opsi disertakan di bawah ini. Untuk deskripsi lengkap, lihat
dokumentasi lainnya.

-o DIR, --odir=DIR
direktori untuk meletakkan file output

-i FILE, --baca-antarmuka=FILE
membaca antarmuka dari FILE.

-D FILE, --antarmuka pembuangan=FILE
membuang antarmuka untuk modul-modul ini di FILE.

-l DIR, --lib=DIR
lokasi file bantu Haddock

-h, --html
Menghasilkan dokumentasi dalam format HTML. Beberapa file akan dihasilkan ke dalam
direktori saat ini (atau direktori yang ditentukan jika -o opsi diberikan), termasuk
berikut:

index.html
Halaman tingkat atas dari dokumentasi: daftar modul yang tersedia, menggunakan
lekukan untuk mewakili hierarki jika modulnya hierarkis.

haddock.css
Stylesheet yang digunakan oleh HTML yang dihasilkan. Jangan ragu untuk memodifikasi ini menjadi
ubah warna atau tata letak, atau bahkan tentukan stylesheet Anda sendiri menggunakan
--css .

modul.html
Halaman HTML untuk setiap modul.

doc-index.html, doc-indeks-XX.html
Indeks, dibagi menjadi dua (fungsi/konstruktor dan tipe/kelas, sesuai
ruang nama Haskell) dan selanjutnya dibagi berdasarkan abjad.

--hoogle
keluaran untuk Hoogle

--html-bantuan=format
menghasilkan indeks dan daftar isi dalam format mshelp, mshelp2 atau devhelp (dengan -h)

--sumber-basis=URL
Sertakan tautan ke file sumber dalam dokumentasi yang dihasilkan, di mana URL adalah
URL dasar tempat file sumber dapat ditemukan.

-s url, --sumber-modul=URL
Sertakan tautan ke file sumber dalam dokumentasi yang dihasilkan, di mana URL adalah
link kode sumber untuk setiap modul (menggunakan %{FILE} atau %{MODULE} vars).

--sumber-entitas=URL
Sertakan tautan ke file sumber dalam dokumentasi yang dihasilkan, di mana URL adalah
tautan kode sumber untuk setiap entitas (menggunakan %{FILE}, %{MODULE} atau %{NAME} vars).

--komentar-basis=URL
URL untuk tautan komentar pada konten dan halaman indeks.

--komentar-modul=URL
URL untuk tautan komentar untuk setiap modul (menggunakan var %{MODULE}).

--komentar-entitas=URL
URL untuk tautan komentar untuk setiap entitas (menggunakan %{FILE}, %{MODULE} atau %{NAME}
var).

--css=FILE
Gunakan CSS FILE alih-alih stylesheet default yang disertakan haddock untuk HTML
keluaran. Itu harus menentukan kelas tertentu: lihat lembar gaya default untuk detailnya.

-p FILE, --prolog=FILE
Tentukan file yang berisi teks prolog.

-t TITLE, --judul=TITLE
penggunaan TITLE sebagai judul halaman untuk setiap halaman dalam dokumentasi. Ini akan
biasanya menjadi nama perpustakaan yang didokumentasikan.

Judul harus berupa string biasa (jangan markup!).

-k NAMA, --paket=NAMA
Tentukan nama paket (opsional).

-n, --no-implisit-prelude
jangan berasumsi Prelude diimpor

-d, --debug
Aktifkan output debug tambahan.

-?, --membantu
Tampilkan bantuan.

-V, --Versi: kapan
Versi tampilan.

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

--gunakan-isi=URL
Gunakan halaman konten HTML yang dibuat secara terpisah.

--gen-konten
Hasilkan konten HTML dari antarmuka yang ditentukan.

--gunakan-indeks=URL
Gunakan indeks HTML yang dibuat secara terpisah.

--gen-indeks
Hasilkan indeks HTML dari antarmuka yang ditentukan.

--abaikan-semua-ekspor
Berperilaku seolah-olah semua modul memiliki atribut abaikan-ekspor

--sembunyikan=MODUL
Berperilaku seolah-olah MODUL memiliki atribut sembunyikan.

--gunakan-paket=PAKET
Modul yang sedang diproses bergantung pada PAKET.

Gunakan haddock online menggunakan layanan onworks.net