gjdoc-4.8 - Dalam Talian di Awan

JADUAL:

NAMA

cp-tools - Panduan Alatan Classpath GNU

SINOPSIS

gjdoc [-sourcepath senarai laluan]
[-semua] [-subpakej pkg:pkg:...] [-kecualikan pkglist]
[-pengekodan carta] [-tempatan nama] [-sumber melepaskan]
[-awam] [-dilindungi] [-pakej] [-peribadi]
[-doctitle teks] [-kepala teks] [-pengaki teks] [-bawah teks]
[-pautan url] [-linkoffline url jalan] [-tiada kelayakan pkg:pkg:...]
[-tagletpath senarai laluan] [-taglet nama kelas] [-tag tagspec]
[-gunakan] [-sumber pautan] [-splitindex] [-noindex] [-notree]
[-turun] [-penulis] [-nosince] [-addstylesheet fail]
[-d targetdir]
[pakej...] [fail sumber...] [@cmdfile]

gjdoc [-sourcepath senarai laluan]
[-semua] [-subpakej pkg:pkg:...] [-kecualikan pkglist]
[-pengekodan carta] [-tempatan nama] [-sumber melepaskan]
[-awam] [-dilindungi] [-pakej] [-peribadi]
[-docletpath senarai laluan] [-doclet nama kelas]
[pakej...] [fail sumber...] [@cmdfile]
[pilihan dokumen]

gjdoc - membantu

gjdoc --versi

Hanya pilihan yang paling berguna disenaraikan di sini; lihat di bawah untuk bakinya.

DESCRIPTION

Gjdoc boleh digunakan dalam dua cara: sebagai alat dokumentasi yang berdiri sendiri, atau sebagai pemacu untuk a
Doclet yang ditentukan pengguna.

Dalam mod lalai, Gjdoc akan menggunakan Dokumen Standard HtmlDoclet untuk menjana satu set
halaman HTML. Penggunaan kanonik ialah:

gjdoc -s src/java/ -all -d api-docs/

Di sini, src/java/ ialah punca hierarki kelas kod sumber anda, -semua bermakna semua sah
Fail Java yang ditemui di bawah direktori akar ini harus diproses dan api-docs/ adalah
direktori di mana dokumentasi yang dihasilkan harus diletakkan.

Untuk mengetahui lebih lanjut tentang menjalankan Doclet selain daripada Standard Doclet, rujuk manual.

PILIHAN

Lebih Baik Ringkasan by Jenis

Berikut ialah ringkasan semua pilihan Gjdoc dan Dokumen Standard, dikumpulkan mengikut
taip. Penjelasan ada di bahagian berikut.

Source Tetapkan Pilihan
-sourcepath senarai laluan -subpakej pkglist -kecualikan pkglist

Source format Pilihan
-sumber melepaskan -pengekodan pengekodan -breakiterator

Berkaitan Pilihan
-pautan url -linkoffline url fail -tiada kelayakan pkg:pkg:...

Generasi Pilihan
-penulis -teks lesen -gunakan -turun -splitindex -noindex
-tidak digunakan lagi -senarai nodeprecated -nohelp -nonavbar
-nosince -notree -awam -dilindungi -pakej -peribadi
-docfilessubdirs -excludedocfilessubdir nama panggilan
-sumber pautan

Output Pilihan
-d -tempatan nama -charset carta -pengekodan dokumen carta
-sahhtml -baseurl url

Hiasan Pilihan
-tajuk tingkap teks -doctitle teks -tajuk teks
-kepala teks -pengaki teks -bawah teks
-fail bantuan fail -stylesheetfile fail -addstylesheet fail
-kumpulan pengepalaan kumpulan pkgpattern:pkgpattern:...

Taglet Pilihan
-tagletpath -taglet nama kelas -tag tagspec

Doklet Pilihan
-docletpath -doclet nama kelas

Kata Kerja Pilihan
-senyap -berkata-kata

Maya mesin Pilihan
-laluan kelas -bootclasspath -J vmopt

Memilih yang Source Fail kepada Proses

-s senarai laluan
-sourcepath senarai laluan
Cari fail sumber dalam direktori atau direktori yang ditentukan.

senarai laluan hendaklah satu atau lebih laluan direktori yang dipisahkan oleh laluan platform anda
pemisah (biasanya : or ;).

Jika pilihan ini tidak diberikan, gjdoc akan mencari fail sumber dalam semasa
direktori.

Direktori yang ditentukan mestilah direktori akar dari segi pakej Java
sistem. Sebagai contoh, jika anda ingin menjana dokumentasi untuk kelas dalam pakej
foo.bar, anda mesti menentukan direktori yang mengandungi peringkat teratas foo sub-direktori,
bukan direktori foo/bar/ di mana fail sumber Java berada.

Alias ​​pendek -s adalah khusus kepada gjdoc dan tidak serasi dengan Sun javadoc.

-semua
[PERCUBAAN] Proses semua fail sumber Java yang sah yang terdapat dalam direktori yang disenaraikan
laluan sumber dan sub-direktorinya.

Ini adalah pilihan khusus untuk gjdoc dan tidak serasi dengan Sun javadoc.

-subpakej pkg:pkg:...
Proses kelas dalam pakej Java yang diberikan dan semua subpakej, secara rekursif.
Ambil perhatian bahawa berbilang nama pakej mesti dipisahkan dengan titik bertindih dan bukannya ruang putih.

-kecualikan pkg:pkg:...
Jangan proses kelas dalam pakej Java yang diberikan dan semua sub-pakej, secara rekursif.
Pilihan ini boleh digunakan bersama dengan -semua or -subpakej untuk mengecualikan
pakej individu atau subpokok pakej daripada output.

pakej...
Proses semua kelas dalam pakej Java yang diberikan.

fail sumber...
Proses kelas dalam fail sumber Java yang diberikan.

Menentukan yang format of Input Fail

-sumber melepaskan
Andaikan bahawa fail sumber disasarkan pada keluaran platform Java yang diberikan.

melepaskan hendaklah nombor versi keluaran platform Java dalam format
MAJOR.MINOR, contohnya 1.4.

Pilihan ini diabaikan pada masa ini kecuali ralat dibangkitkan jika nombor keluaran
selain daripada 1.2, 1.3 or 1.4 dinyatakan.

-pengekodan carta
Andaikan bahawa fail sumber dikodkan menggunakan carta.

Contoh untuk carta adalah AS-ASCII, ISO-8859-1 or UTF-8.

Semantik daripada carta adalah sama dengan mereka
java.nio.charset.Charset.forName(String).

-breakiterator
Gunakan java.text.BreakIterator setempat dan bukannya ayat pertama dalaman
pengesan.

Secara lalai, gjdoc menggunakan algoritma dalaman untuk menentukan di mana ayat itu berakhir. Bila
pilihan ini diberikan, ia sebaliknya akan menggunakan java.text.BreakIterator contoh untuk
tempatan diberikan dengan -tempatan (atau tempat lalai).

Pilihan ini harus dinyatakan semasa memohon gjdoc kepada kod sumber yang diulas dalam bukan
bahasa latin yang mana pengesan ayat pertama lalai tidak berfungsi. Untuk semua
kes lain, lalai (jangan gunakan BreakIterator) menghasilkan keputusan yang lebih baik di
masa penulisan ini.

Berkaitan bersama lain dokumentasi Set

-pautan url
Cipta hiperpautan ke set dokumentasi lain.

Secara lalai, gjdoc hanya akan membuat hiperpautan ke kelas dalam set sumber. Guna ini
pilihan untuk membuat hiperpautan tambahan kepada kelas yang diliputi oleh yang ditentukan
set dokumentasi.

url mestilah URL akar set dokumentasi yang lain. Sebagai contoh, untuk menambah
hiperpautan ke GNU Classpath, nyatakan yang berikut:

-pautan http://developer.classpath.org/doc/

. -pautan pilihan boleh ditentukan beberapa kali.

Perhatikan bahawa menyatakan -pautan pilihan akan menyebabkan akses HTTP setiap kali gjdoc
diseru. Anda boleh gunakan -linkoffline sebaliknya untuk mengelakkan akses ini.

-linkoffline url fail
Cipta hiperpautan ke set dokumentasi lain yang turut terdapat pada fail setempat
sistem.

Pilihan ini berfungsi sama seperti -pautan, kecuali ia mengakses sistem fail tempatan
bukannya rangkaian untuk menentukan kelas mana yang diliputi oleh yang dipautkan
set dokumentasi.

Apabila menggunakan -linkoffline set dokumentasi jauh tidak diakses sama sekali, yang boleh
mempercepatkan masa penjanaan dengan ketara bergantung pada sambungan rangkaian anda. The
menjana hiperpautan ke set dokumentasi walau bagaimanapun merujuk kepada set jauh, bukan kepada
yang tempatan, supaya anda boleh mengedarkan dokumentasi tanpa perlu lagi
kebergantungan.

. -linkoffline pilihan boleh ditentukan beberapa kali.

-tiada kelayakan pkg:pkg:...
Jangan layakkan nama kelas dalam pakej yang diberikan dengan nama pakejnya.

Secara lalai, nama kelas dipaparkan tidak layak hanya jika kelas itu adalah sebahagian daripada
set sumber atau set dokumentasi yang dipautkan, dan layak dengan namanya
mengandungi bungkusan jika tidak. Anda boleh menggunakan pilihan ini untuk memaksa nama yang tidak layak
untuk kelas walaupun mereka bukan sebahagian daripada set dokumentasi.

Sebagai contoh, biasanya rujukan kepada kelas String diwakili layak sepenuhnya sebagai
java.lang.String (melainkan anda memaut ke set dokumentasi yang sesuai menggunakan -pautan)
kerana ia bukan sebahagian daripada set dokumentasi. Anda boleh menentukan -tiada kelayakan
java.lang untuk memberikan rujukan yang sama seperti Rentetan.

Ambil perhatian bahawa untuk semua nama kelas yang tidak layak, petua alat disediakan apabila anda meletakkan anda
tetikus di atasnya dalam dokumentasi HTML.

-tiada kelayakan semua
Abaikan kelayakan nama pakej daripada semua nama kelas.

Tentukan pilihan ini untuk meninggalkan kelayakan nama pakej sama sekali,

Memilih yang Maklumat kepada Menjana

-awam
Hanya masukkan ahli awam kelas awam dalam output. Secara lalai, dilindungi
ahli kelas turut disertakan.

-dilindungi
Sertakan orang awam atau ahli kelas awam yang dilindungi dalam output. Ini adalah
lalai.

-pakej
Sertakan ahli awam, dilindungi dan pakej-swasta awam dan pakej-swasta
kelas.

-peribadi
Sertakan semua kelas dan ahli kelas tanpa mengira tahap akses mereka.

-splitindex
Hasilkan satu halaman indeks setiap huruf dan bukannya satu halaman indeks monolitik.

Secara lalai, indeks yang dibuat oleh Dokumen Standard mengandungi semua entri pada satu
muka surat. Ini baik untuk set dokumentasi kecil, tetapi untuk set besar anda perlu
nyatakan pilihan ini.

-nosince
Mengabaikan @sejak tag dalam ulasan javadoc.

Secara lalai, output yang dijana mengandungi bahagian yang menyenaraikan versi API anda
yang mana pakej, kelas atau ahli kelas yang dipersoalkan wujud apabila tag ini
dihadapi. Tentukan pilihan ini untuk meninggalkan maklumat ini.

-notree
Jangan jana sebarang halaman pokok.

Secara lalai, output yang dijana termasuk satu pokok warisan setiap pakej, dan - jika
set dokumentasi terdiri daripada berbilang pakej - halaman dengan warisan penuh
pokok. Tentukan pilihan ini untuk meninggalkan penjanaan halaman ini.

-noindex
Jangan keluarkan indeks abjad.

Secara lalai, gjdoc menjana indeks abjad semua elemen program dalam
set dokumentasi (pakej, kelas, kelas dalaman, pembina, kaedah dan
padang). Tentukan pilihan ini untuk meninggalkan maklumat ini.

-nohelp
Jangan jana halaman bantuan.

Pilihan ini diabaikan pada masa ini kerana Dokumen Standard tidak menyediakan halaman bantuan.

-tidak digunakan lagi
Jangan keluarkan maklumat sebaris tentang pakej, kelas atau ahli kelas yang tidak digunakan lagi.

Secara lalai, Dokumen Standard menambah perenggan yang diserlahkan dengan penamatan
maklumat kepada huraian setiap elemen program yang tidak digunakan lagi. Nyatakan ini
pilihan untuk meninggalkan maklumat ini.

-senarai nodeprecated
Jangan keluarkan halaman ringkasan untuk elemen API yang ditamatkan.

Secara lalai, Dokumen Standard menjana halaman yang menyenaraikan semua elemen API yang tidak digunakan lagi
bersama-sama dengan perihalan penamatan yang biasanya termasuk sebab penamatan
dan alternatif yang mungkin. Tentukan pilihan ini untuk meninggalkan maklumat ini.

-nonavbar
Jangan keluarkan bar navigasi, pengepala dan pengaki.

Secara lalai, setiap halaman output dilengkapi dengan bar navigasi atas (yang mungkin termasuk
pengepala yang ditentukan pengguna) dan bar navigasi bawah (yang mungkin termasuk pengguna-
pengaki yang ditentukan). Tentukan pilihan ini untuk meninggalkan hiasan ini.

-tiada komen
Abaikan semua teks dokumentasi daripada fail yang dijana dan keluarkan sahaja pengisytiharan dan
perhubungan elemen program.

Pilihan ini ada di sini untuk keserasian dengan javadoc. Jika anda bercadang untuk mengekstrak
maklumat tentang projek anda melalui gjdoc, anda harus mempertimbangkan untuk menggunakan Doclet yang berbeza
sebaliknya untuk tujuan anda, contohnya XmlDoclet. Anda juga boleh menggunakan API Doclet
secara langsung dengan melaksanakan Doclet baharu.

-sumber pautan
Hasilkan halaman dengan kod sumber yang diserlahkan sintaks untuk setiap kelas. Secara lalai, ini
halaman tidak dijana.

Kod sumber boleh diakses dengan mengklik pada butang berlabel "Sumber" dalam
bar navigasi, atau dengan mengklik pada nama pembina, medan, kaedah atau dalam
kelas dalam bahagian perincian halaman dokumentasi kelas.

-gunakan
Hasilkan halaman dengan maklumat rujukan silang. Secara lalai, halaman ini bukan
dihasilkan.

Maklumat rujukan silang boleh diakses dengan mengklik pada butang berlabel
`Gunakan' dalam bar navigasi.

Halaman `Gunakan' menyenaraikan semua kelas/antara muka dalam set dokumentasi itu
melanjutkan/melaksanakan kelas (jenis) berkenaan; bidang jenis; kaedah atau
pembina menerima parameter jenis; kaedah mengembalikan jenis; dan
kaedah atau pembina melontar jenis.

-penulis
Sertakan maklumat pengarang dalam output.

Apabila dinyatakan, maklumat pengarang seperti yang dinyatakan menggunakan @pengarang tag dalam javadoc
komen dimasukkan ke dalam output. Secara lalai, @pengarang tag diabaikan.

-turun
Sertakan maklumat versi dalam output.

Apabila dinyatakan, maklumat versi seperti yang dinyatakan menggunakan @versi tag dalam javadoc
komen dimasukkan ke dalam output. Secara lalai, @versi tag diabaikan.

-teks lesen
Andaikan komen pertama dalam setiap fail sumber mengandungi teks lesen dan tambah
maklumat lesen kepada pengaki setiap halaman kelas yang dijana.

Ini adalah pilihan khusus untuk gjdoc dan tidak serasi dengan Sun javadoc.

Pilihan ini bertujuan untuk digunakan dengan projek sumber bebas dan terbuka dengan kod sumber
biasanya diawali dengan ulasan lesen plat dandang, apabila terdapat sebab undang-undang
untuk memasukkan lesen dalam dokumentasi.

-docfilessubdirs
Salin secara rekursif semua fail dalam fail-dokumen sub-direktori setiap direktori pakej.

Biasanya, hanya fail dalam fail-dokumen sub-direktori disalin tanpa menurun
secara berulang.

-excludedocfilessubdir nama:nama: ...
Jangan salin beberapa direktori terus di bawah fail-dokumen sub-direktori apabila
menurun secara rekursif.

Argumen untuk pilihan ini hendaklah senarai nama direktori yang dipisahkan bertindih.

Pilihan ini hanya masuk akal jika -docfilessubdirs juga dinyatakan. Dalam kes ini, mana-mana
sub-direktori terletak betul-betul di bawah a fail-dokumen direktori ditinggalkan jika disenaraikan.

Adat dokumentasi Tags

-tagletpath senarai laluan
Cari senarai laluan apabila memuatkan kelas Taglet berikutnya yang ditentukan menggunakan -taglet.

senarai laluan hendaklah satu atau lebih laluan ke direktori atau fail jar, dipisahkan oleh anda
pemisah laluan platform (biasanya : or ;).

-taglet nama kelas
Daftarkan Taglet.

nama kelas mestilah nama yang layak sepenuhnya bagi pelaksana kelas Java
com.sun.tools.doclets.Taglet.

Kelas Taglet akan dimuatkan daripada laluan kelas yang digunakan -tagletpath, Dari
laluan kelas yang ditentukan menggunakan -laluan kelas dan daripada laluan kelas lalai.

Lihat dokumentasi bagi com.sun.tools.doclets.Taglet untuk maklumat lanjut.

Ambil perhatian bahawa untuk tag mudah, terdapat juga -tag.

-tag tagspec
Daftarkan Taglet generik.

Format tagspec mesti : :" ".

nama tag ialah nama tag untuk dipadankan, tanpa tanda @ di hadapan.

bendera ialah satu atau lebih daripada aksara berikut, di mana setiap aksara menyatakan a
konteks kod sumber di mana teg itu akan dikenali.

a semua konteks

c pembina

f bidang

m kaedah

o gambaran keseluruhan

p pakej

t jenis (kelas, antara muka, pengecualian, ralat)

X watak istimewa yang melumpuhkan Taglet buat sementara waktu.

taghead ialah rentetan untuk dipaparkan dalam pengepala bahagian yang dikhaskan untuk teg dalam
Soalan.

Contohnya, untuk menentukan padanan teg @cvsid yang akan diterima dalam gambaran keseluruhan,
pakej dan taip halaman dan yang dilabelkan dengan pengepala CVS ID, Awak akan
nyatakan:

-tag cvsid:tpo:"ID CVS"

Katakan bahawa ulasan javadoc kelas mengandungi

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Kemudian output HTML akan mengandungi sesuatu seperti

ID CVS:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Berlari lain-lain Doklet

-docletpath senarai laluan
Cari senarai laluan apabila memuatkan kelas untuk Doclet yang ditentukan menggunakan -doclet.

senarai laluan hendaklah satu atau lebih laluan ke direktori atau fail jar, dipisahkan oleh anda
pemisah laluan platform (biasanya : or ;).

-doclet nama kelas
Jalankan doclet yang ditentukan dan bukannya HtmlDoclet standard.

nama kelas hendaklah nama layak sepenuhnya bagi kelas yang mempunyai lalai awam
pembina dan mengandungi kaedah dengan tandatangan berikut:

import com.sun.javadoc.RootDoc;
permulaan boolean statik awam (RootDoc ​​rootDoc)

Kelas Doclet akan dimuatkan dari laluan kelas yang digunakan -docletpath, Dari
laluan kelas yang ditentukan menggunakan -laluan kelas dan daripada laluan kelas lalai.

. permulaan kaedah harus memproses maklumat yang didedahkan oleh API Doclet melalui rootDoc
dan kembali benar pada kejayaan, palsu pada kegagalan.

Jika anda menggunakan dokumen pihak ketiga, rujuk dokumentasinya untuk maklumat lanjut
arahan. Ambil perhatian bahawa sokongan untuk doclets pihak ketiga adalah percubaan. Tolonglah
laporkan sebarang masalah yang anda hadapi, atau berikan maklum balas apabila berjaya dijalankan
applet pihak ketiga.

Pilihan ini boleh ditentukan beberapa kali, dalam hal ini semua doclets dilaksanakan
dengan pepohon maklumat yang sama didedahkan melalui API Doclet untuk setiap larian Doclet.

Menambah Maklumat kepada yang Output

-tajuk tingkap teks
Penggunaan teks sebagai awalan tajuk tetingkap penyemak imbas.

Apabila dinyatakan, tajuk tetingkap penyemak imbas untuk setiap halaman akan diawali dengan teks
bukannya rentetan lalai Generated API dokumentasi.

teks mestilah teks biasa (ia tidak sepatutnya mengandungi tag HTML).

-doctitle teks
Tetapkan teks pengepala halaman gambaran keseluruhan kepada teks.

teks mestilah rentetan teks biasa yang pendek.

Apabila menjana dokumentasi untuk satu pakej, nyatakan pilihan ini memaksa
penjanaan halaman gambaran keseluruhan.

-kepala htmltext
Tambah htmltext ke sudut kanan atas setiap halaman yang dijana. htmltext biasanya
ditetapkan kepada nama projek yang didokumenkan.

-pengaki htmltext
Tambah htmltext ke sudut kanan bawah setiap halaman yang dijana. htmltext sering
ditetapkan kepada nilai yang sama seperti untuk -kepala.

-bawah htmltext
Tambah htmltext ke bahagian paling bawah setiap halaman yang dijana, merangkumi keseluruhan lebar
halaman tersebut. Apabila dinyatakan, htmltext biasanya terdiri daripada notis hak cipta dan/atau
pautan ke halaman projek lain.

-addstylesheet fail
Tambah helaian gaya CSS lalai dengan helaian gaya yang ditentukan pengguna fail.

Lembaran gaya yang diberikan hanya dimuatkan oleh setiap halaman HTML sebagai tambahan kepada lalai
satu, sebagai lembaran gaya terakhir.

Ambil perhatian bahawa peraturan melata CSS dikenakan. Iaitu, sifat gaya anda hanya akan
ditetapkan jika mereka mempunyai susunan lata yang lebih tinggi daripada gjdocgaya lalai. Satu yang mudah
cara untuk memastikan bahawa perkara ini berlaku adalah dengan mengisytiharkan penggantian anda ! penting.

Lihathttp://www.w3.org/TR/REC-CSS2/cascade.html#pesanan-melata>.

-kumpulan menuju pkgwildcard:pkgwildcard: ...
Susun pakej yang diberikan dalam kumpulan berasingan pada halaman gambaran keseluruhan.

Hujah pertama mestilah teks biasa pendek yang digunakan sebagai tajuk
kumpulan pakej. Argumen kedua hendaklah senarai pakej yang dipisahkan dengan titik bertindih
kad bebas. Kumpulan itu akan terdiri daripada semua pakej dalam set dokumentasi yang namanya
sepadan dengan mana-mana kad bebas yang diberikan.

Hanya ada satu watak kad bebas, *, yang sepadan dengan kedua-dua huruf dalam nama pakej
komponen dan . mengasingkan komponen nama pakej. Sebagai contoh, j*regex akan
pakej perlawanan java.util.regex. Contoh yang lebih berguna ialah javax.swing* untuk perlawanan
javax.swing dan semua subpakejnya.

Pilihan ini boleh diberikan beberapa kali.

FIXME: Maklumat tentang sarang kumpulan di sini.

gjdoc -kumpulan "Kelas Teras" 'java*' \
-kumpulan "Swing" 'javax.swing*' \
-kumpulan "API XML" 'javax.xml*' \
-kumpulan "Sambungan Lain" javax* \
...

- gambaran keseluruhan fail
Tambahkan serpihan badan XHTML daripada fail ke halaman gambaran keseluruhan.

fail harus mengandungi serpihan XHTML dengan HTML badan tag sebagai nod akar.

Pilihan ini boleh digunakan untuk membekalkan perihalan set dokumentasi secara keseluruhan.

Apabila dinyatakan, ayat pertama serpihan akan diletakkan di atas jadual
menyenaraikan pakej yang didokumenkan, bersama-sama dengan pautan ke salinan penuh serpihan itu
yang diletakkan di bawah jadual.

Apabila menjana dokumentasi untuk satu pakej, nyatakan pilihan ini memaksa
penjanaan halaman gambaran keseluruhan.

-stylesheetfile fail
Gunakan helaian gaya CSS dalam fail bukannya helaian gaya CSS lalai.

Jika anda hanya mahu mengatasi bahagian helaian gaya lalai, gunakan -addstylesheet
sebaliknya.

-tajuk teks
Ditamatkan. Penggunaan -doctitle teks sebaliknya.

-fail bantuan fail
Pilihan ini diabaikan pada masa ini.

Apabila dilaksanakan, ia akan menggunakan serpihan XHTML dalam fail untuk kandungan halaman bantuan
bukannya teks bantuan lalai.

Mengawal yang Pengeluaran.

-d direktori
Letakkan semua fail output ke dalam direktori (dan sub-direktori). direktori akan diwujudkan
jika ia tidak wujud, termasuk semua direktori induk yang tidak wujud dan semua yang diperlukan
sub-direktori.

Jika tidak dinyatakan, output akan diletakkan ke dalam direktori semasa.

-tempatan nama
Gunakan setempat nama bukannya tempat lalai untuk semua tujuan.

nama hendaklah penentu tempat dalam bentuk ll_CC[_VAR] di mana ll ialah huruf kecil dua-
surat kod bahasa ISO-639, CC ialah negara pilihan dua huruf besar ISO-3166
kod, dan VAR ialah kod varian pilihan. Sebagai contoh, en menyatakan bahasa Inggeris, en_us
menentukan bahasa Inggeris AS, dan en_US_WIN menentukan varian menyimpang bagi bahasa Inggeris AS
tempat.

Ambil perhatian bahawa semantik pilihan ini sepadan dengan tepat kepada pembina
dari kelas java.util.Locale.

Pilihan ini pada masa ini hanya menentukan Pengumpul yang sedang digunakan untuk mengisih output
elemen. Ini bermakna bahawa tempat itu hanya akan mempunyai kesan apabila anda menggunakan bukan-
aksara ASCII dalam pengecam.

-charset carta
Ditamatkan. Gantikan pengekodan yang ditentukan dalam output fail XHTML dengan yang diberikan
by carta.

Jika pilihan ini tidak diberikan, spesifikasi pengekodan dalam output XHTML dipilih untuk
padankan pengekodan yang digunakan semasa menulis fail (pengekodan yang diberikan dengan -pengekodan dokumen,
atau pengekodan lalai platform anda).

Semantik untuk carta dinyatakan di sini:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. Untuk semua tujuan praktikal,
ia adalah sama dengan pilihan lain yang menerima parameter charset.

Pilihan ini ada di sini untuk keserasian dengan javadoc dan harus dielakkan.

-pengekodan dokumen carta
Gunakan pengekodan charset yang diberikan semasa menulis fail output dan bukannya platform anda
pengekodan lalai.

Contoh untuk carta adalah AS-ASCII, ISO-8859-1 or UTF-8.

Semantik pilihan ini sepadan dengan tepat kepada pembina kelas
java.util.Locale.

-sahhtml
Penjanaan paksa kod XHTML yang sah. Ini memecahkan keserasian kepada tradisional
Alat Javadoc sedikit sebanyak.

Jika pilihan ini ditentukan, nama sauh akan rosak supaya ia sah
mengikut spesifikasi XHTML 1.1. Walau bagaimanapun, set dokumentasi dijana dengan
pilihan ini tidak boleh dipautkan dengan betul menggunakan alat Javadoc tradisional. Ia boleh
dipautkan dengan baik menggunakan Gjdoc, walaupun.

Tanpa pilihan ini, nama sauh untuk ahli kelas boleh laku menggunakan tradisional
format, sebagai contoh: "foo(String,int[])". Ini serasi dengan tradisional
Alat Javadoc, tetapi menurut kedua-dua spesifikasi HTML 4.0 dan XHTML 1.0 dan 1.1,
format ini termasuk aksara haram. Tanda kurung, kurungan segi empat sama dan koma
tidak dibenarkan dalam nama sauh.

-baseurl url
Kawat keras URL halaman berbanding dengan url ke dalam setiap halaman yang dihasilkan.

Jika anda menjana dokumentasi yang akan tersedia secara eksklusif di tempat tertentu
URL, anda harus menggunakan pilihan ini untuk menentukan URL ini.

Ini boleh membantu mengelakkan serangan ubah hala tertentu yang digunakan oleh penghantar spam, dan ini boleh membantu
untuk pelanggan web tertentu.

Kata Kerja Pilihan

-senyap
Sekat semua output kecuali amaran dan mesej ralat.

-berkata-kata
Bercakap-cakap tentang apa gjdoc sedang membuat.

Pilihan ini diabaikan pada masa ini.

Maya mesin Pilihan

Matahari javadoc alat nampaknya berdasarkan bahasa jawa dan oleh itu ia seolah-olah beroperasi pada VM
peringkat. gjdoc, sebaliknya, ialah aplikasi Java tulen.

Oleh itu, gjdoc hanya boleh memalsukan, atau mensimulasikan, pilihan peringkat VM berikut.

-laluan kelas senarai laluan
Tetapkan Mesin Maya jalan kelas kepada senarai laluan.

Dalam kebanyakan kes anda harus menggunakan -docletpath or -tagletpath bukannya pilihan ini.

senarai laluan hendaklah satu atau lebih laluan ke direktori atau fail jar, dipisahkan oleh anda
pemisah laluan platform (biasanya : or ;).

Jika pilihan ini tidak dipintas pada tahap pembalut, gjdoc pada masa ini memalsukannya oleh
memanggil System.setProperty("java.class.path", senarai laluan); dan mengeluarkan amaran.

-bootclasspath senarai laluan
Tetapkan Mesin Maya bootclasspath kepada senarai laluan.

Jika pilihan ini tidak dipintas pada tahap pembalut, gjdoc mengeluarkan amaran.

-Jvmopt
Hantar parameter sewenang-wenangnya kepada Mesin Maya gjdoc berjalan terus.

Jika pilihan ini tidak dipintas pada tahap pembalut, gjdoc cuba mencontohi
pilihan dan mengeluarkan amaran.

Pada masa ini, hanya pilihan VM -D untuk menetapkan sifat sistem dicontohi.

Gunakan gjdoc-4.8 dalam talian menggunakan perkhidmatan onworks.net