ocamldoc.opt - Dalam Talian di Awan

JADUAL:

NAMA

ocamldoc - Penjana dokumentasi OCaml

SINOPSIS

ocamldoc [ pilihan ] nama fail ...

DESCRIPTION

Penjana dokumentasi OCaml ocamldoc(1) menjana dokumentasi daripada khas
ulasan yang dibenamkan dalam fail sumber. Komen yang digunakan oleh ocamldoc adalah dalam bentuk (** ...
*) dan ikut format yang diterangkan dalam . OCaml pengguna manual.

ocamldoc boleh menghasilkan dokumentasi dalam pelbagai format: HTML, LaTeX, TeXinfo, Unix man
halaman, dan dot(1) graf pergantungan. Selain itu, pengguna boleh menambah penjana tersuai mereka sendiri.

Dalam halaman manual ini, kami menggunakan perkataan elemen untuk merujuk kepada mana-mana bahagian berikut an
Fail sumber OCaml: pengisytiharan jenis, nilai, modul, pengecualian, jenis modul, a
pembina jenis, medan rekod, kelas, jenis kelas, kaedah kelas, nilai kelas atau
klausa pewarisan kelas.

PILIHAN

Pilihan baris arahan berikut menentukan format untuk dokumentasi yang dijana
dijana oleh ocamldoc(1).

Pilihan khususnya memilih yang output format
-html Hasilkan dokumentasi dalam format lalai HTML. Halaman HTML yang dihasilkan disimpan
dalam direktori semasa, atau dalam direktori yang ditentukan dengan -d pilihan. Awak boleh
sesuaikan gaya halaman yang dijana dengan mengedit yang dihasilkan style.css fail,
atau dengan menyediakan helaian gaya anda sendiri menggunakan pilihan -gaya css. Fail style.css
tidak dijana jika ia sudah wujud.

-lateks Hasilkan dokumentasi dalam format lalai LaTeX. Dokumen LaTeX yang dihasilkan ialah
disimpan dalam fail ocamldoc.out, atau dalam fail yang dinyatakan dengan -o pilihan. The
dokumen menggunakan fail gaya ocamldoc.sty. Fail ini dijana apabila menggunakan fail
-lateks pilihan, jika ia belum wujud. Anda boleh menukar fail ini untuk menyesuaikan
gaya dokumentasi LaTeX anda.

-texi Hasilkan dokumentasi dalam format lalai TeXinfo. Dokumen LaTeX yang dihasilkan ialah
disimpan dalam fail ocamldoc.out, atau dalam fail yang dinyatakan dengan -o pilihan.

-lelaki Hasilkan dokumentasi sebagai satu set halaman manusia Unix. Halaman yang dihasilkan disimpan
dalam direktori semasa, atau dalam direktori yang ditentukan dengan -d pilihan.

-titik Hasilkan graf pergantungan untuk modul peringkat atas, dalam format yang sesuai untuk
memaparkan dan memproses oleh dot(1). The dot(1) alat boleh didapati daripada
http://www.research.att.com/sw/tools/graphviz/. Perwakilan tekstual bagi
graf ditulis pada fail ocamldoc.out, atau ke fail yang ditentukan dengan -o
pilihan. Gunakan dot ocamldoc.out untuk memaparkannya.

-g fail
Muatkan fail yang diberikan secara dinamik (sambungan yang biasanya .cmo atau .cma), yang
mentakrifkan penjana dokumentasi tersuai. Jika fail yang diberikan adalah yang mudah dan
tidak wujud dalam direktori semasa, maka ocamldoc mencarinya dalam adat
direktori lalai generators, dan dalam direktori yang ditentukan dengan -i pilihan.

-customdir
Paparkan direktori lalai penjana tersuai.

-i direktori
Tambahkan direktori yang diberikan pada laluan untuk mencari penjana tersuai.

Umum pilihan
-d dir Hasilkan fail dalam direktori dir, bukannya direktori semasa.

-pembuangan fail
Buang maklumat yang dikumpul ke dalam fail. Maklumat ini boleh dibaca dengan -load
pilihan dalam seruan seterusnya ocamldoc(1).

-sembunyi modul
Sembunyikan nama modul lengkap yang diberikan dalam dokumentasi yang dijana. modul ialah
senarai nama modul lengkap dipisahkan dengan koma (,), tanpa kosong. Untuk
contoh: Pervasives,M2.M3.

-inv-merge-ml-mli
Balikkan keutamaan pelaksanaan dan antara muka apabila digabungkan. Semua
elemen dalam fail pelaksanaan disimpan, dan -m pilihan menunjukkan bahagian mana
komen dalam fail antara muka digabungkan dengan ulasan dalam pelaksanaan
fail.

-simpan-kod
Sentiasa simpan kod sumber untuk nilai, kaedah dan pembolehubah contoh, apabila
tersedia. Kod sumber sentiasa disimpan apabila fail .ml diberikan, tetapi oleh
lalai dibuang apabila .mli diberikan. Pilihan ini membolehkan kod sumber menjadi
sentiasa disimpan.

-load fail
Muatkan maklumat daripada fail, yang telah dihasilkan oleh ocamldoc -pembuangan. Beberapa
-load pilihan boleh diberikan.

-m bendera
Tentukan pilihan gabungan antara antara muka dan pelaksanaan. bendera boleh jadi satu atau
beberapa watak berikut:

d huraian gabungan

a gabungkan @pengarang

v gabungkan @versi

l gabungkan @lihat

s gabungkan @sejak

o gabungkan @tidak digunakan lagi

p gabungkan @param

e gabungkan @naikkan

r gabungkan @kembali

A menggabungkan segala-galanya

-tiada-tag tersuai
Jangan benarkan @-tag tersuai.

-jangan berhenti
Simpan elemen diletakkan selepas (**/**) komen khas.

-o fail
Keluarkan dokumentasi yang dijana kepada fail bukan ocamldoc.out. Pilihan ini adalah
bermakna hanya bersempena dengan -lateks, -texi, Atau -titik pilihan.

-pp arahan
Sumber paip melalui prapemproses arahan.

-ppx arahan
Paip pokok sintaks abstrak melalui prapemproses arahan.

-susun Isih senarai modul peringkat atas sebelum menjana dokumentasi.

-bintang Alih keluar aksara kosong sehingga asterisk pertama ('*') dalam setiap baris ulasan.

-t tajuk
Penggunaan tajuk sebagai tajuk untuk dokumentasi yang dihasilkan.

-intro fail
Gunakan kandungan daripada fail as ocamldoc teks untuk digunakan sebagai pengenalan (HTML, LaTeX dan
TeXinfo sahaja). Untuk HTML, fail digunakan untuk mencipta keseluruhan fail "index.html".

-v Mod bertele-tele. Paparkan maklumat kemajuan.

-turun
Cetak rentetan versi dan keluar.

-vnum Cetak nombor versi pendek dan keluar.

-amaran-kesilapan
Rawat ocamldoc amaran sebagai kesilapan.

-sembunyi-amaran
Jangan cetak ocamldoc amaran.

-membantu or - membantu
Paparkan ringkasan penggunaan ringkas dan keluar.

Semakan jenis pilihan
ocamldoc(1) memanggil penyemak jenis OCaml untuk mendapatkan maklumat jenis. Pilihan berikut
memberi kesan kepada fasa pemeriksaan jenis. Mereka mempunyai makna yang sama seperti untuk
ocamlc(1) dan ocamlopt(1) perintah.

-I direktori
Tambah direktori ke senarai direktori cari fail antara muka yang disusun (.cmi
fail).

-nolabel
Abaikan label bukan pilihan dalam jenis.

-recttypes
Benarkan jenis rekursif sewenang-wenangnya. (Lihat -recttypes pilihan untuk ocamlc(1).)

Pilihan khususnya menjana HTML muka surat
Pilihan berikut digunakan bersama dengan -html pilihan:

-semua-params
Paparkan senarai lengkap parameter untuk fungsi dan kaedah.

-gaya css nama fail
Penggunaan nama fail sebagai fail Lembaran Gaya Cascading.

-warna-kod
Warnakan kod OCaml yang disertakan dalam [ ] dan \{[ ]\}, menggunakan warna untuk menekankan
kata kunci, dsb. Jika serpihan kod tidak betul dari segi sintaksis, tiada warna
ditambah.

-indeks sahaja
Hasilkan fail indeks sahaja.

-fungsi pendek
Gunakan borang pendek untuk memaparkan functors: modul M : pelawak (A:Modul) -> pelawak
(B:Modul2) -> Sig .. akhir dipaparkan sebagai modul M (A:Modul) (B:Modul2) : Sig ..
akhir.

Pilihan khususnya menjana LaTeX fail
Pilihan berikut digunakan bersama dengan -lateks pilihan:

-awalan-nilai-lateks awalan
Berikan awalan untuk digunakan untuk label nilai dalam dokumen LaTeX yang dijana.
Awalan lalai ialah rentetan kosong. Anda juga boleh menggunakan pilihan -jenis lateks-
awalan, -awalan-pengecualian lateks, -awalan-modul lateks, -awalan-jenis-modul lateks,
-awalan-kelas-lateks, -awalan-jenis-kelas-lateks, -awalan-atribut-lateks, dan -lateks-
awalan kaedah.

Pilihan ini berguna apabila anda mempunyai, sebagai contoh, jenis dan nilai dengan
nama yang sama. Jika anda tidak menyatakan awalan, LaTeX akan mengadu tentang darab
label yang ditentukan.

-tajuk lateks n, gaya
Nombor gaya bersekutu n kepada arahan pembahagian LaTeX yang diberikan gaya, contohnya
seksyenorsubseksyen. (LaTeX sahaja.) Ini berguna apabila menyertakan yang dijana
dokumen dalam dokumen LaTeX lain, pada tahap keratan yang diberikan. lalai
persatuan ialah 1 untuk seksyen, 2 untuk subseksyen, 3 untuk subsubseksyen, 4 untuk
perenggan dan 5 untuk subperenggan.

-noheader
Sekat pengepala dalam dokumentasi yang dijana.

-notoc Jangan jana jadual kandungan.

-notrailer
Sekat treler dalam dokumentasi yang dijana.

-sepfiles
Hasilkan satu fail .tex bagi setiap modul peringkat atas, bukannya global ocamldoc.out
fail.

Pilihan khususnya menjana TeXinfo fail
Pilihan berikut digunakan bersama dengan -texi pilihan:

-esc8 Melarikan diri aksara beraksen dalam fail Maklumat.

-masukan-maklumat
Nyatakan entri direktori Maklumat.

-bahagian-maklumat
Tentukan bahagian direktori Maklumat.

-noheader
Sekat pengepala dalam dokumentasi yang dijana.

-noindex
Jangan bina indeks untuk fail Maklumat.

-notrailer
Sekat treler dalam dokumentasi yang dijana.

Pilihan khususnya menjana dot graf
Pilihan berikut digunakan bersama dengan -titik pilihan:

-warna-titik warna
Tentukan warna untuk digunakan dalam kod titik yang dijana. Apabila menjana modul
kebergantungan, ocamldoc(1) menggunakan warna yang berbeza untuk modul, bergantung pada
direktori di mana mereka tinggal. Apabila menjana kebergantungan jenis, ocamldoc(1)
menggunakan warna yang berbeza untuk jenis, bergantung pada modul di mana ia berada
ditakrifkan. warna ialah senarai nama warna yang dipisahkan dengan koma (,), seperti dalam
Merah, Biru, Hijau. Warna yang tersedia adalah yang disokong oleh dot(1) alat.

-titik-termasuk-semua
Sertakan semua modul dalam dot(1) output, bukan sahaja modul yang diberikan pada arahan
talian atau dimuatkan dengan -load pilihan.

-titik-kurangkan
Lakukan pengurangan transitif graf pergantungan sebelum mengeluarkan titik
kod. Ini boleh berguna jika terdapat banyak kebergantungan transitif yang berantakan
graf tersebut.

-jenis-titik
Kod titik keluaran yang menerangkan graf pergantungan jenis dan bukannya modul
graf pergantungan.

Pilihan khususnya menjana lelaki fail
Pilihan berikut digunakan bersama dengan -lelaki pilihan:

-lelaki-mini
Hasilkan halaman manual hanya untuk modul, jenis modul, kelas dan jenis kelas
daripada halaman untuk semua elemen.

-man-akhiran akhiran
Tetapkan akhiran yang digunakan untuk nama fail lelaki yang dijana. Lalai ialah o, seperti dalam Senarai.o.

-bahagian lelaki seksyen
Tetapkan nombor bahagian yang digunakan untuk nama fail lelaki yang dijana. Lalai ialah 3.

Gunakan ocamldoc.opt dalam talian menggunakan perkhidmatan onworks.net