gjdoc-4.8 - Daring di Cloud

PROGRAM:

NAMA

cp-tools - Panduan Alat Classpath GNU

RINGKASAN

gjdoc [-jalur sumber daftar jalur]
[-semua] [-subpaket pkg:pkg:...] [-mengecualikan daftar pkg]
[-pengkodean rangkaian karakter] [-lokal nama] [-source melepaskan]
[-publik] [-terlindung] [-paket] [-pribadi]
[-judul dokumen teks] [-tajuk teks] [-catatan kaki teks] [-bawah teks]
[-tautan url] [-tautan offline url path] [-nokualifikasi pkg:pkg:...]
[-jalur taglet daftar jalur] [-taglet nama kelas] [-menandai spesifikasi tag]
[-menggunakan] [-sumber tautan] [-splitindex] [-tidak ada indeks] [-catatan]
[-versi] [-Pengarang] [-tidak ada] [-tambahkan lembar gaya fillet]
[-d targetdir]
[paket...] [file sumber...] [@file cmd]

gjdoc [-jalur sumber daftar jalur]
[-semua] [-subpaket pkg:pkg:...] [-mengecualikan daftar pkg]
[-pengkodean rangkaian karakter] [-lokal nama] [-source melepaskan]
[-publik] [-terlindung] [-paket] [-pribadi]
[-jalur dokumen daftar jalur] [-doklet nama kelas]
[paket...] [file sumber...] [@file cmd]
[opsi doclet]

gjdoc --membantu

gjdoc --Versi: kapan

Hanya opsi yang paling berguna yang tercantum di sini; lihat di bawah untuk sisanya.

DESKRIPSI

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

Dalam mode default, Gjdoc akan menggunakan Doclet Standar HTMLDoclet untuk menghasilkan satu set
halaman HTML. Penggunaan kanonik adalah:

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

Di sini, src/java/ adalah akar dari hierarki kelas kode sumber Anda, -semua berarti semua valid
File Java yang ditemukan di bawah direktori root ini harus diproses, dan api-dokumen/ adalah
direktori tempat dokumentasi yang dihasilkan harus ditempatkan.

Untuk mempelajari lebih lanjut tentang menjalankan Doclet selain Doclet Standar, lihat manual.

PILIHAN

pilihan Kesimpulan by Tipe

Berikut adalah ringkasan dari semua opsi Gjdoc dan Standard Doclet, dikelompokkan berdasarkan
Tipe. Penjelasan ada di bagian berikut.

sumber set Opsi
-jalur sumber daftar jalur -subpaket daftar pkg -mengecualikan daftar pkg

sumber dibentuk Opsi
-source melepaskan -pengkodean encoding -pembobol

Saling menghubungkan Opsi
-tautan url -tautan offline url fillet -nokualifikasi pkg:pkg:...

Generasi Opsi
-Pengarang -teks lisensi -menggunakan -versi -splitindex -tidak ada indeks
-simpul tidak digunakan lagi -daftar node yang tidak digunakan lagi -tidak ada pertolongan -nonavbar
-tidak ada -catatan -publik -terlindung -paket -pribadi
-docfilessubdirs -excludedocfilessubdir nama dirname
-sumber tautan

Keluaran Opsi
-d -lokal nama -set karakter rangkaian karakter -kode dokumen rangkaian karakter
-validhtml -baseurl url

Dekorasi Opsi
-judul jendela teks -judul dokumen teks -judul teks
-tajuk teks -catatan kaki teks -bawah teks
-file bantuan fillet -file lembar gaya fillet -tambahkan lembar gaya fillet
-kelompok judul grup pola pkg: pola pkg:...

taglet Opsi
-jalur taglet -taglet nama kelas -menandai spesifikasi tag

dokumen Opsi
-jalur dokumen -doklet nama kelas

Verbositas Opsi
-diam -verbose

maya Mesin Opsi
-jalur kelas - jalur kelas boot -J vmopt

Memilih yang sumber File untuk Proses

-s daftar jalur
-jalur sumber daftar jalur
Cari file sumber di direktori atau direktori yang ditentukan.

daftar jalur harus berupa satu atau lebih jalur direktori yang dipisahkan oleh jalur platform Anda
pemisah (biasanya : or ;).

Jika opsi ini tidak diberikan, gjdoc akan mencari file sumber di saat ini
direktori.

Direktori yang ditentukan harus direktori root dalam hal paket Java
sistem. Misalnya, jika Anda ingin membuat dokumentasi untuk kelas dalam paket
foo.bar, Anda harus menentukan direktori yang berisi level teratas foo sub-direktori,
bukan direktori foo/bar/ di mana file sumber Java berada.

Alias ​​tangan pendek -s khusus untuk gjdoc dan tidak kompatibel dengan Sun javadoc.

-semua
[EKSPERIMENTAL] Memproses semua file sumber Java yang valid yang ditemukan di direktori yang terdaftar di
jalur sumber dan sub-direktori mereka.

Ini adalah opsi khusus untuk gjdoc dan tidak kompatibel dengan Sun javadoc.

-subpaket pkg:pkg:...
Memproses kelas dalam paket Java yang diberikan dan semua sub-paket, secara rekursif.
Perhatikan bahwa beberapa nama paket harus dipisahkan dengan titik dua, bukan spasi.

-mengecualikan pkg:pkg:...
Jangan memproses kelas dalam paket Java yang diberikan dan semua sub-paket, secara rekursif.
Opsi ini dapat digunakan bersama dengan -semua or -subpaket untuk mengecualikan
paket individu atau sub-pohon paket dari output.

paket...
Memproses semua kelas dalam paket Java yang diberikan.

file sumber...
Memproses kelas dalam file sumber Java yang diberikan.

Menentukan itu dibentuk of Memasukkan File

-source melepaskan
Asumsikan bahwa file sumber ditargetkan pada rilis tertentu dari platform Java.

melepaskan harus nomor versi rilis platform Java dalam format
MAYOR.MINOR, misalnya 1.4.

Opsi ini saat ini diabaikan kecuali bahwa kesalahan muncul jika nomor rilis
selain 1.2, 1.3 or 1.4 ditentukan.

-pengkodean rangkaian karakter
Asumsikan bahwa file sumber dikodekan menggunakan rangkaian karakter.

Contoh untuk rangkaian karakter adalah US-ASCII, ISO-8859-1 or UTF-8.

Semantik dari rangkaian karakter identik dengan
java.nio.charset.Charset.forName(String).

-pembobol
Gunakan java.text.BreakIterator lokal alih-alih kalimat pertama internal
detektor.

Secara default, gjdoc menggunakan algoritma internal untuk menentukan di mana kalimat berakhir. Kapan
opsi ini diberikan, itu malah akan menggunakan java.teks.BreakIterator contoh untuk
lokal diberikan dengan -lokal (atau lokal default).

Opsi ini harus ditentukan saat melamar gjdoc ke kode sumber dikomentari dalam non-
bahasa latin yang pendeteksi kalimat pertama defaultnya tidak berfungsi. Untuk semua
kasus lain, default (jangan gunakan BreakIterator) menghasilkan hasil yang lebih baik di
waktu penulisan ini.

Saling menghubungkan dengan lain Dokumentasi set

-tautan url
Buat hyperlink ke kumpulan dokumentasi lain.

Secara default, gjdoc hanya akan membuat hyperlink ke kelas di set sumber. Gunakan ini
opsi untuk membuat hyperlink tambahan ke kelas yang dicakup oleh yang ditentukan
kumpulan dokumentasi.

url harus menjadi URL root dari kumpulan dokumentasi lainnya. Misalnya, untuk menambahkan
hyperlink ke GNU Classpath, tentukan yang berikut ini:

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

Grafik -tautan pilihan dapat ditentukan beberapa kali.

Perhatikan bahwa menentukan -tautan opsi akan menyebabkan akses HTTP setiap kali gjdoc diaktifkan
dipanggil. Anda dapat gunakan -tautan offline sebagai gantinya untuk menghindari akses ini.

-tautan offline url fillet
Buat hyperlink ke kumpulan dokumentasi lain yang juga ada di file lokal
sistem.

Opsi ini berfungsi persis seperti -tautan, kecuali mengakses sistem file lokal
alih-alih jaringan untuk menentukan kelas mana yang dicakup oleh yang ditautkan
kumpulan dokumentasi.

Ketika menggunakan -tautan offline set dokumentasi jarak jauh tidak diakses sama sekali, yang dapat
secara signifikan mempercepat waktu pembuatan tergantung pada koneksi jaringan Anda. NS
hyperlink yang dihasilkan ke set dokumentasi namun merujuk ke set jarak jauh, bukan ke
yang lokal, sehingga Anda dapat mendistribusikan dokumentasi tanpa lebih jauh
ketergantungan.

Grafik -tautan offline pilihan dapat ditentukan beberapa kali.

-nokualifikasi pkg:pkg:...
Tidak memenuhi syarat nama kelas dalam paket yang diberikan dengan nama paketnya.

Secara default, nama kelas ditampilkan tanpa pengecualian hanya jika kelas tersebut adalah bagian dari
kumpulan sumber atau kumpulan dokumentasi tertaut, dan memenuhi syarat dengan nama-nya
berisi paket jika tidak. Anda dapat menggunakan opsi ini untuk memaksa nama yang tidak memenuhi syarat
untuk kelas bahkan jika mereka bukan bagian dari set dokumentasi.

Sebagai contoh, biasanya referensi ke kelas String direpresentasikan sepenuhnya memenuhi syarat sebagai
java.lang.String (kecuali Anda menautkan ke kumpulan dokumentasi yang sesuai menggunakan -tautan)
karena itu bukan bagian dari kumpulan dokumentasi. Anda dapat menentukan -nokualifikasi
java.lang untuk membuat referensi yang sama seperti Tali.

Perhatikan bahwa untuk semua nama kelas yang tidak memenuhi syarat, tooltip disediakan saat Anda menempatkan
penunjuk mouse di atasnya dalam dokumentasi HTML.

-nokualifikasi semua
Abaikan kualifikasi nama paket dari semua nama kelas.

Tentukan opsi ini untuk menghilangkan kualifikasi nama paket sama sekali,

Memilih yang Informasi untuk Menghasilkan

-publik
Hanya sertakan anggota publik dari kelas publik dalam output. Secara default, dilindungi
anggota kelas juga disertakan.

-terlindung
Sertakan anggota publik atau kelas publik yang dilindungi dalam output. Ini adalah
standar.

-paket
Sertakan anggota publik, dilindungi, dan paket-pribadi dari publik dan paket-pribadi
kelas.

-pribadi
Sertakan semua kelas dan anggota kelas terlepas dari tingkat akses mereka.

-splitindex
Hasilkan satu halaman indeks per huruf alih-alih satu halaman indeks monolitik.

Secara default, indeks yang dibuat oleh Standard Doclet berisi semua entri pada satu
halaman. Ini bagus untuk set dokumentasi kecil, tetapi untuk set besar Anda harus
tentukan opsi ini.

-tidak ada
mengabaikan @sejak tag di komentar javadoc.

Secara default, output yang dihasilkan berisi bagian yang mencantumkan versi API Anda
sejak paket, kelas, atau anggota kelas yang dimaksud ada saat tag ini
ditemui. Tentukan opsi ini untuk menghilangkan informasi ini.

-catatan
Jangan buat halaman pohon apa pun.

Secara default, output yang dihasilkan menyertakan satu pohon warisan per paket, dan - jika
set dokumentasi terdiri dari beberapa paket - halaman dengan warisan penuh
pohon. Tentukan opsi ini untuk menghilangkan pembuatan halaman ini.

-tidak ada indeks
Jangan menampilkan indeks abjad.

Secara default, gjdoc menghasilkan indeks abjad dari semua elemen program di
kumpulan dokumentasi (paket, kelas, kelas dalam, konstruktor, metode, dan
bidang). Tentukan opsi ini untuk menghilangkan informasi ini.

-tidak ada pertolongan
Jangan buat halaman bantuan.

Opsi ini saat ini diabaikan karena Doclet Standar tidak menyediakan halaman bantuan.

-simpul tidak digunakan lagi
Jangan menampilkan informasi sebaris tentang paket, kelas, atau anggota kelas yang tidak digunakan lagi.

Secara default, Doclet Standar menambahkan paragraf yang disorot dengan penghentian
informasi ke deskripsi setiap elemen program usang. Tentukan ini
pilihan untuk menghilangkan informasi ini.

-daftar node yang tidak digunakan lagi
Jangan menampilkan halaman ringkasan untuk elemen API yang tidak digunakan lagi.

Secara default, Standard Doclet menghasilkan halaman yang mencantumkan semua elemen API yang tidak digunakan lagi
bersama dengan deskripsi penghentian yang biasanya menyertakan alasan penghentian
dan kemungkinan alternatif. Tentukan opsi ini untuk menghilangkan informasi ini.

-nonavbar
Jangan menampilkan bilah navigasi, header, dan footer.

Secara default, setiap halaman keluaran dilengkapi dengan bilah navigasi atas (yang mungkin termasuk:
header yang ditentukan pengguna) dan bilah navigasi bawah (yang mungkin menyertakan
catatan kaki yang ditentukan). Tentukan opsi ini untuk menghilangkan dekorasi ini.

-tidak ada komentar
Hilangkan semua teks dokumentasi dari file yang dihasilkan dan deklarasi hanya keluaran dan
hubungan elemen program.

Opsi ini ada di sini untuk kompatibilitas dengan javadoc. Jika Anda berencana untuk mengekstrak
informasi tentang proyek Anda melalui gjdoc, Anda harus mempertimbangkan untuk menggunakan Doclet yang berbeda
untuk tujuan Anda, misalnya XmlDoclet. Anda juga bisa menggunakan Doclet API
langsung dengan mengimplementasikan Doclet baru.

-sumber tautan
Hasilkan halaman dengan kode sumber yang disorot sintaks untuk setiap kelas. Secara default, ini
halaman tidak dibuat.

Kode sumber dapat diakses dengan mengklik tombol berlabel "Sumber" di
bilah navigasi, atau dengan mengklik nama konstruktor, bidang, metode, atau bagian dalam
kelas di bagian detail halaman dokumentasi kelas.

-menggunakan
Hasilkan halaman dengan informasi referensi silang. Secara default, halaman ini tidak
dihasilkan.

Informasi referensi silang dapat diakses dengan mengklik tombol berlabel
'Gunakan' di bilah navigasi.

Halaman `Gunakan' mencantumkan semua kelas/antarmuka dalam set dokumentasi yang
memperluas/menerapkan kelas (tipe) yang dimaksud; bidang jenis; metode atau
konstruktor menerima parameter tipe; metode mengembalikan tipe; dan
metode atau konstruktor yang melempar tipe.

-Pengarang
Sertakan informasi penulis dalam output.

Ketika ditentukan, informasi penulis seperti yang ditentukan menggunakan @Pengarang tag di javadoc
komentar dimasukkan ke dalam output. Secara default, @Pengarang tag diabaikan.

-versi
Sertakan informasi versi dalam output.

Saat ditentukan, informasi versi seperti yang ditentukan menggunakan @Versi: kapan tag di javadoc
komentar dimasukkan ke dalam output. Secara default, @Versi: kapan tag diabaikan.

-teks lisensi
Asumsikan bahwa komentar pertama di setiap file sumber berisi teks lisensi, dan tambahkan
informasi lisensi ke footer dari setiap halaman kelas yang dihasilkan.

Ini adalah opsi khusus untuk gjdoc dan tidak kompatibel dengan Sun javadoc.

Opsi ini dimaksudkan untuk digunakan dengan proyek sumber terbuka dan gratis di mana kode sumber
biasanya diawali dengan komentar lisensi boilerplate, bila ada alasan hukum
untuk menyertakan lisensi dalam dokumentasi.

-docfilessubdirs
Salin semua file secara rekursif di file-dokumen sub-direktori dari setiap direktori paket.

Biasanya, hanya file dalam file-dokumen sub-direktori disalin tanpa turun
secara rekursif.

-excludedocfilessubdir nama:nama: ...
Jangan menyalin beberapa direktori langsung di bawah file-dokumen sub-direktori ketika
turun secara rekursif.

Argumen untuk opsi ini harus berupa daftar nama direktori yang dipisahkan titik dua.

Opsi ini hanya masuk akal jika -docfilessubdirs juga ditentukan. Dalam hal ini, apapun
sub-direktori yang terletak tepat di bawah a file-dokumen direktori dihilangkan jika terdaftar.

Kustom Dokumentasi Tag

-jalur taglet daftar jalur
Pencarian daftar jalur saat memuat kelas Taglet berikutnya yang ditentukan menggunakan -taglet.

daftar jalur harus berupa satu atau lebih jalur ke direktori atau file jar, dipisahkan oleh
pemisah jalur platform (biasanya : or ;).

-taglet nama kelas
Daftarkan Taglet.

nama kelas harus merupakan nama yang sepenuhnya memenuhi syarat dari implementasi kelas Java
com.sun.tools.doclets.Taglet.

Kelas Taglet akan dimuat dari classpath yang ditentukan menggunakan -jalur taglet, Dari
classpath yang ditentukan menggunakan -jalur kelas dan dari classpath default.

Lihat dokumentasi dari com.sun.tools.doclets.Taglet untuk informasi lebih lanjut.

Perhatikan bahwa untuk tag sederhana, ada juga -menandai.

-menandai spesifikasi tag
Daftarkan Taglet generik.

Format spesifikasi tag harus : :" ".

nama tag adalah nama tag yang cocok, tanpa tanda @ di depan.

bendera adalah satu atau lebih dari karakter berikut, di mana setiap karakter menentukan a
konteks kode sumber di mana tag akan dikenali.

a semua konteks

c konstruktor

f bidang

m metode

o ikhtisar

p paket

t jenis (kelas, antarmuka, pengecualian, kesalahan)

X karakter khusus yang menonaktifkan Taglet untuk sementara.

kepala tag adalah string untuk ditampilkan di header bagian yang dikhususkan untuk tag di
pertanyaan.

Misalnya, untuk menentukan pencocokan tag @cvsid yang harus diterima dalam tinjauan umum,
paket dan ketik halaman dan yang diberi label dengan header CVS ID, kamu akan
menentukan:

-tag cvsid:tpo:"ID CVS"

Katakanlah komentar javadoc kelas berisi

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

Kemudian output HTML akan berisi sesuatu seperti

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

Running Lainnya Doklet

-jalur dokumen daftar jalur
Pencarian daftar jalur saat memuat kelas untuk Doclet yang ditentukan menggunakan -doklet.

daftar jalur harus berupa satu atau lebih jalur ke direktori atau file jar, dipisahkan oleh
pemisah jalur platform (biasanya : or ;).

-doklet nama kelas
Jalankan doclet yang ditentukan alih-alih HtmlDoclet standar.

nama kelas harus menjadi nama kelas yang sepenuhnya memenuhi syarat yang memiliki default publik
konstruktor dan berisi metode dengan tanda tangan berikut:

impor com.sun.javadoc.RootDoc;
mulai boolean statis publik (RootDoc ​​rootDoc)

Kelas Doclet akan dimuat dari classpath yang ditentukan menggunakan -jalur dokumen, Dari
classpath yang ditentukan menggunakan -jalur kelas dan dari classpath default.

Grafik awal metode harus memproses informasi yang diekspos oleh Doclet API melalui rootDok
dan kembali benar pada kesuksesan, palsu pada kegagalan.

Jika Anda menggunakan dokumen pihak ketiga, lihat dokumentasinya untuk lebih lanjut
instruksi. Perhatikan bahwa dukungan untuk doclet pihak ketiga bersifat eksperimental. Tolong
laporkan masalah apa pun yang Anda temui, atau berikan umpan balik saat berhasil berjalan
applet pihak ketiga.

Opsi ini dapat ditentukan beberapa kali, dalam hal ini semua doclet dieksekusi
dengan pohon informasi yang sama yang diekspos melalui Doclet API untuk setiap menjalankan Doclet.

Menambahkan Informasi untuk itu Keluaran

-judul jendela teks
penggunaan teks sebagai awalan judul jendela browser.

Jika ditentukan, judul jendela browser untuk setiap halaman akan diawali dengan teks
alih-alih string default Dihasilkan API Dokumentasi.

teks harus berupa teks biasa (tidak boleh berisi tag HTML).

-judul dokumen teks
Setel teks tajuk halaman ikhtisar ke teks.

teks harus berupa string teks biasa pendek.

Saat membuat dokumentasi untuk satu paket, menentukan opsi ini memaksa
pembuatan halaman ikhtisar.

-tajuk teks html
Add teks html ke sudut kanan atas setiap halaman yang dihasilkan. teks html biasanya
diatur ke nama proyek yang didokumentasikan.

-catatan kaki teks html
Add teks html ke sudut kanan bawah setiap halaman yang dihasilkan. teks html sering
diatur ke nilai yang sama seperti untuk -tajuk.

-bawah teks html
Add teks html ke bagian paling bawah dari setiap halaman yang dihasilkan, mencakup seluruh lebar
halaman. Ketika ditentukan, teks html biasanya terdiri dari pemberitahuan hak cipta dan/atau
link ke halaman proyek lain.

-tambahkan lembar gaya fillet
Tambahkan lembar gaya CSS default dengan lembar gaya yang ditentukan pengguna fillet.

Stylesheet yang diberikan hanya dimuat oleh setiap halaman HTML selain default
yang, sebagai stylesheet terakhir.

Perhatikan bahwa aturan kaskade CSS berlaku. Artinya, properti gaya Anda hanya akan menjadi
ditugaskan jika mereka memiliki urutan cascading yang lebih tinggi daripada gjdocgaya default. Satu sederhana
cara untuk memastikan bahwa ini masalahnya adalah dengan mendeklarasikan penggantian Anda Penting!.

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

-kelompok menuju pkgwilcard:pkgwilcard: ...
Atur paket yang diberikan dalam grup terpisah di halaman ikhtisar.

Argumen pertama harus berupa teks biasa pendek yang digunakan sebagai judul
kelompok paket. Argumen kedua harus berupa daftar paket yang dipisahkan titik dua
wildcard. Grup akan terdiri dari semua paket dalam kumpulan dokumentasi yang namanya
cocok dengan salah satu wildcard yang diberikan.

Hanya ada satu karakter wildcard, *, yang cocok dengan kedua huruf dalam nama paket
komponen dan . memisahkan komponen nama paket. Sebagai contoh, j*regex akan
paket pertandingan java.util.regex. Contoh yang lebih berguna adalah javax.ayunan* untuk mencocokkan
javax.ayunan dan semua sub-paketnya.

Opsi ini dapat diberikan beberapa kali.

FIXME: Informasi tentang grup bersarang di sini.

gjdoc -group "Kelas Inti" 'java*' \
-group "Swing" 'javax.swing*' \
-grup "XML API" 'javax.xml*' \
-grup "Ekstensi Lain" javax* \
...

-gambaran fillet
Tambahkan fragmen tubuh XHTML dari fillet ke halaman ikhtisar.

fillet harus berisi fragmen XHTML dengan HTML tubuh tag sebagai simpul akar.

Opsi ini dapat digunakan untuk memberikan deskripsi kumpulan dokumentasi secara keseluruhan.

Saat ditentukan, kalimat pertama dari fragmen akan diletakkan di atas tabel
daftar paket yang didokumentasikan, bersama dengan tautan ke salinan lengkap fragmen
yang diletakkan di bawah tabel.

Saat membuat dokumentasi untuk satu paket, menentukan opsi ini memaksa
pembuatan halaman ikhtisar.

-file lembar gaya fillet
Gunakan lembar gaya CSS di fillet alih-alih stylesheet CSS default.

Jika Anda hanya ingin mengganti bagian dari stylesheet default, gunakan -tambahkan lembar gaya
sebagai gantinya.

-judul teks
Tidak digunakan lagi. penggunaan -judul dokumen teks sebagai gantinya.

-file bantuan fillet
Opsi ini saat ini diabaikan.

Saat diimplementasikan, itu akan menggunakan fragmen XHTML di fillet untuk konten halaman bantuan
alih-alih teks bantuan default.

Mengontrol itu Keluaran.

-d direktori
Tempatkan semua file output ke dalam direktori (dan sub-direktori). direktori akan dibuat
jika tidak ada, termasuk semua direktori induk yang tidak ada dan semua yang diperlukan
sub-direktori.

Jika tidak ditentukan, output akan ditempatkan ke direktori saat ini.

-lokal nama
Gunakan lokal nama alih-alih lokal default untuk semua tujuan.

nama harus menjadi penentu lokal dalam bentuk akan_CC[_VAR] dimana ll adalah huruf kecil dua-
kode bahasa huruf ISO-639, CC adalah negara ISO-3166 dua huruf huruf besar opsional
kode, dan VAR adalah kode varian opsional. Sebagai contoh, en menentukan bahasa Inggris, en_US
menentukan bahasa Inggris AS, dan id_US_WIN menentukan varian menyimpang dari bahasa Inggris AS
lokal.

Perhatikan bahwa semantik opsi ini sesuai persis dengan konstruktor
kelas java.util.Lokal.

Opsi ini saat ini hanya menentukan Collator mana yang digunakan untuk menyortir output
elemen. Ini berarti bahwa lokal hanya akan berpengaruh ketika Anda menggunakan non-
Karakter ASCII dalam pengidentifikasi.

-set karakter rangkaian karakter
Tidak digunakan lagi. Ganti pengkodean yang ditentukan dalam file XHTML keluaran dengan yang diberikan
by rangkaian karakter.

Jika opsi ini tidak diberikan, spesifikasi pengkodean dalam output XHTML dipilih untuk
cocok dengan pengkodean yang digunakan saat menulis file (pengkodean diberikan dengan -kode dokumen,
atau penyandian default platform Anda).

Semantik untuk rangkaian karakter ditentukan di sini:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. Untuk semua tujuan praktis,
mereka identik dengan opsi lain yang menerima parameter rangkaian karakter.

Opsi ini ada di sini untuk kompatibilitas dengan javadoc dan harus dihindari.

-kode dokumen rangkaian karakter
Gunakan pengkodean rangkaian karakter yang diberikan saat menulis file keluaran alih-alih platform Anda
pengkodean default.

Contoh untuk rangkaian karakter adalah US-ASCII, ISO-8859-1 or UTF-8.

Semantik opsi ini sesuai persis dengan konstruktor kelas
java.util.Lokal.

-validhtml
Memaksa pembuatan kode XHTML yang valid. Ini merusak kompatibilitas dengan tradisional
Alat Javadoc sampai batas tertentu.

Jika opsi ini ditentukan, nama jangkar akan dirusak sehingga valid
sesuai dengan spesifikasi XHTML 1.1. Namun, satu set dokumentasi yang dihasilkan dengan
opsi ini tidak dapat ditautkan dengan benar menggunakan alat Javadoc tradisional. Bisa
ditautkan dengan baik menggunakan Gjdoc.

Tanpa opsi ini, nama jangkar untuk anggota kelas yang dapat dieksekusi menggunakan tradisional
format, misalnya: "foo(String,int[])". Ini kompatibel dengan tradisional
Alat Javadoc, tetapi menurut spesifikasi HTML 4.0 dan XHTML 1.0 dan 1.1,
format ini termasuk karakter ilegal. Tanda kurung, kurung siku, dan koma
tidak diperbolehkan dalam nama jangkar.

-baseurl url
Pasangkan URL halaman relatif terhadap url ke setiap halaman yang dihasilkan.

Jika Anda membuat dokumentasi yang secara eksklusif akan tersedia pada waktu tertentu
URL, Anda harus menggunakan opsi ini untuk menentukan URL ini.

Ini dapat membantu menghindari serangan pengalihan tertentu yang digunakan oleh spammer, dan ini dapat membantu
untuk klien web tertentu.

Verbositas Opsi

-diam
Menekan semua output kecuali untuk peringatan dan pesan kesalahan.

-verbose
Bersikaplah sangat bertele-tele tentang apa gjdoc sedang melakukan.

Opsi ini saat ini diabaikan.

maya Mesin Opsi

matahari javadoc alat tampaknya didasarkan pada Jawa dan karena itu tampaknya beroperasi pada VM
tingkat. gjdoc, sebaliknya, adalah aplikasi Java murni.

Oleh karena itu, gjdoc hanya dapat memalsukan, atau mensimulasikan, opsi tingkat VM berikut.

-jalur kelas daftar jalur
Setel Mesin Virtual jalur kelas untuk daftar jalur.

Dalam kebanyakan kasus, Anda harus menggunakan -jalur dokumen or -jalur taglet alih-alih opsi ini.

daftar jalur harus berupa satu atau lebih jalur ke direktori atau file jar, dipisahkan oleh
pemisah jalur platform (biasanya : or ;).

Jika opsi ini tidak dicegat pada tingkat pembungkus, gjdoc saat ini memalsukannya dengan
panggilan System.setProperty("java.class.path", daftar jalur); dan mengeluarkan peringatan.

- jalur kelas boot daftar jalur
Setel Mesin Virtual jalur bootclass untuk daftar jalur.

Jika opsi ini tidak dicegat pada tingkat pembungkus, gjdoc mengeluarkan peringatan.

-Jvmopt
Berikan parameter arbitrer ke Mesin Virtual gjdoc berjalan.

Jika opsi ini tidak dicegat pada tingkat pembungkus, gjdoc mencoba meniru
opsi dan mengeluarkan peringatan.

Saat ini, hanya opsi VM -D untuk pengaturan properti sistem ditiru.

Gunakan gjdoc-4.8 online menggunakan layanan onworks.net