gjdoc-4.8 - Bulutta Çevrimiçi

Program:

ADI

cp araçları - GNU Sınıfyolu Araçları Kılavuzu

SİNOPSİS

gjdoc [-kaynak yolu yol listesi]
[-herşey] [-alt paketler paket:pkg:...] [-hariç tutmak pkglist]
[-kodlama karakter kümesi] [-yerel isim] [-kaynak serbest]
[-halka açık] [korumalı] [-paket] [-özel]
[-belge başlığı metin] [-başlık metin] [-altbilgi metin] [-alt metin]
[-Link url] [-bağlantıçevrimdışı url yol] [-niteleyici paket:pkg:...]
[-etiket yolu yol listesi] [-etiket sınıf adı] [-etiket etiket belirtimi]
[-kullanır] [-bağlantı kaynağı] [-splitindex] [-noindex] [-notree]
[-version] [-yazar] [-o zamandan beri] [-eklenti sayfası dosya]
[-d hedefdir]
[paketler...] [kaynak dosyaları...] [@cmd dosyası]

gjdoc [-kaynak yolu yol listesi]
[-herşey] [-alt paketler paket:pkg:...] [-hariç tutmak pkglist]
[-kodlama karakter kümesi] [-yerel isim] [-kaynak serbest]
[-halka açık] [korumalı] [-paket] [-özel]
[-docletyolu yol listesi] [-belge sınıf adı]
[paketler...] [kaynak dosyaları...] [@cmd dosyası]
[belge seçenekleri]

gjdoc --yardım et

gjdoc --versiyon

Burada yalnızca en kullanışlı seçenekler listelenmiştir; geri kalanı için aşağıya bakın.

TANIM

Gjdoc iki şekilde kullanılabilir: bağımsız bir belgeleme aracı olarak veya bir sürücü olarak.
kullanıcı tanımlı Doclet.

Varsayılan modda, Gjdoc Standart Belgeyi kullanacaktır. HtmlDoclet bir dizi oluşturmak için
HTML sayfaları. Kanonik kullanım:

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

Burada, kaynak/java/ kaynak kod sınıfı hiyerarşinizin köküdür, -herşey hepsi geçerli demek
Bu kök dizinde bulunan Java dosyaları işlenmeli ve api-dokümanları/ olduğunu
oluşturulan belgelerin yerleştirileceği dizin.

Standart Doküman dışındaki Dokümanları çalıştırma hakkında daha fazla bilgi için kılavuza bakın.

SEÇENEKLER

seçenek Özet by Tip

Hem Gjdoc hem de Standard Doclet'in tüm seçeneklerinin bir özeti, şu şekilde gruplandırılmıştır:
tip. Açıklamalar aşağıdaki bölümlerde yer almaktadır.

Kaynak set Opsiyonlar
-kaynak yolu yol listesi -alt paketler pkglist -hariç tutmak pkglist

Kaynak oluşturulan Opsiyonlar
-kaynak serbest -kodlama kodlama -kırıcı

birbirine bağlanma Opsiyonlar
-Link url -bağlantıçevrimdışı url dosya -niteleyici paket:pkg:...

nesil Opsiyonlar
-yazar -lisans metni -kullanır -version -splitindex -noindex
-nodeprecated -nodeprecatedlist -yardım yok -nonavbar
-o zamandan beri -notree -halka açık korumalı -paket -özel
-docfilessubdirs -hariç tutulan belge dosyaları alt dizini dizinadı
-bağlantı kaynağı

Çıktı Opsiyonlar
-d -yerel isim -karakter seti karakter kümesi -dosya kodlama karakter kümesi
-geçerlihtml -baseurl url

Dekorasyon Opsiyonlar
-pencere başlığı metin -belge başlığı metin -Başlık metin
-başlık metin -altbilgi metin -alt metin
-yardım dosyası dosya -stil sayfası dosyası dosya -eklenti sayfası dosya
-grubu grup başlığı pkgdesen:pkgdesen:...

etiket Opsiyonlar
-etiket yolu -etiket sınıfadı -etiket etiket belirtimi

belge Opsiyonlar
-docletyolu -belge sınıfadı

lâf salatası Opsiyonlar
-sessiz -ayrıntılı

Sanal makine Opsiyonlar
-sınıf yolu -önyükleme sınıfı yolu -J vmopt

Seçilmesi hangi Kaynak dosyalar için süreci

-s yol listesi
-kaynak yolu yol listesi
Belirtilen dizinde veya dizinlerde kaynak dosyaları arayın.

yol listesi platformunuzun yolu ile ayrılmış bir veya daha fazla dizin yolu olmalıdır
ayırıcı (genellikle : or ;).

Bu seçenek verilmezse, gjdoc geçerli dosyada kaynak dosyaları arayacak
dizin.

Belirtilen dizinler, Java paketi açısından kök dizinler olmalıdır.
sistem. Örneğin, paketteki sınıflar için dokümantasyon oluşturmak istiyorsanız
foo.bar, üst seviyeyi içeren dizini belirtmelisiniz. foo alt dizin,
dizin değil foo/bar/ Java kaynak dosyalarının bulunduğu yer.

Kısa el takma adı -s özeldir gjdoc ve Sun ile uyumlu değil javadoc.

-herşey
[DENEYSEL] Listelenen dizinlerde bulunan tüm geçerli Java kaynak dosyalarını işleyin.
kaynak yolu ve alt dizinleri.

Bu, belirli bir seçenek gjdoc ve Sun ile uyumlu değil javadoc.

-alt paketler paket:pkg:...
Verilen Java paketlerindeki ve tüm alt paketlerdeki sınıfları yinelemeli olarak işleyin.
Birden çok paket adının boşluk yerine iki nokta üst üste ile ayrılması gerektiğini unutmayın.

-hariç tutmak paket:pkg:...
Verilen Java paketlerindeki ve tüm alt paketlerdeki sınıfları yinelemeli olarak işlemeyin.
Bu seçenek ile birlikte kullanılabilir -herşey or -alt paketler hariç tutmak için
çıktıdan bireysel paketler veya paket alt ağaçları.

paketler...
Verilen Java paketlerindeki tüm sınıfları işleyin.

kaynak dosyaları...
Verilen Java kaynak dosyalarındaki sınıfları işleyin.

Belirtme the oluşturulan of Giriş dosyalar

-kaynak serbest
Kaynak dosyaların, Java platformunun verilen sürümünde hedeflendiğini varsayın.

serbest biçimindeki bir Java platformu sürümünün sürüm numarası olmalıdır
MAJOR.MINOR, örneğin 1.4.

Bu seçenek, bir sürüm numarası varsa bir hata oluşması dışında şu anda yok sayılır.
başka 1.2, 1.3 or 1.4 belirtilir.

-kodlama karakter kümesi
Kaynak dosyaların kullanılarak kodlandığını varsayalım. karakter kümesi.

İçin örnekler karakter kümesi vardır US-ASCII, ISO-8859-1 or UTF-8.

Anlambilimi karakter kümesi olanlar ile aynıdır
java.nio.charset.Charset.forName(Dize).

-kırıcı
Dahili ilk cümle yerine yerel ayarın Java.text.BreakIterator'ını kullanın
detektörü.

Varsayılan olarak, gjdoc Cümlenin nerede bittiğini belirlemek için dahili bir algoritma kullanır. Ne zaman
bu seçenek verildiğinde, bunun yerine java.text.BreakIterator için örnek
ile verilen yerel -yerel (veya varsayılan yerel ayar).

Bu seçenek başvuru sırasında belirtilmelidir. gjdoc olmayan bir yorumda kaynak koduna
varsayılan ilk cümle algılayıcısının çalışmadığı latin dili. Hepsi için
diğer durumlarda, varsayılan (BreaIterator kullanmayın) şu anda daha iyi sonuçlar verir.
bu yazının zamanı.

birbirine bağlanma ile diğer belgeleme Setleri

-Link url
Başka bir belge kümesine köprüler oluşturun.

Varsayılan olarak, gjdoc yalnızca kaynak kümesindeki sınıflara köprüler oluşturur. Bunu kullan
ek olarak belirtilen sınıfların kapsadığı sınıflara köprüler oluşturma seçeneği
dokümantasyon seti.

url diğer belge kümesinin kök URL'si olmalıdır. Örneğin, eklemek için
GNU Classpath'e köprüler, aşağıdakileri belirtin:

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

The -Link seçeneği birden çok kez belirtilebilir.

şunu belirtmeyi unutmayın: -Link seçenek, gjdoc her açıldığında bir HTTP erişimine neden olur
çağrılır. Kullanabilirsiniz -bağlantıçevrimdışı bunun yerine bu erişimden kaçınmak için.

-bağlantıçevrimdışı url dosya
Yerel dosyada da bulunan başka bir belge kümesine köprüler oluşturun
sistem.

Bu seçenek tam olarak şu şekilde çalışır -Link, yerel dosya sistemine erişmesi dışında
bağlantılı sınıfların kapsadığını belirlemek için ağ yerine
dokümantasyon seti.

Kullanırken -bağlantıçevrimdışı uzak dokümantasyon setine hiç erişilemiyor, bu da
ağ bağlantınıza bağlı olarak üretim süresini önemli ölçüde hızlandırır. NS
dokümantasyon kümesine oluşturulan köprüler ancak uzak kümeye atıfta bulunur,
yerel olan, böylece belgeleri daha fazla dağıtmanıza gerek kalmadan
bağımlılıklar.

The -bağlantıçevrimdışı seçeneği birden çok kez belirtilebilir.

-niteleyici paket:pkg:...
Verilen paketlerdeki sınıfların adlarını paket adlarıyla nitelemeyin.

Varsayılan olarak, bir sınıf adı yalnızca sınıf, sınıfın bir parçasıysa niteliksiz olarak görüntülenir.
kaynak kümesi veya bağlantılı bir belge kümesidir ve kendi adıyla nitelenir.
değilse paketi içerir. Niteliksiz adları zorlamak için bu seçeneği kullanabilirsiniz.
belgeler kümesinin bir parçası olmasalar bile sınıflar için.

Örneğin, genellikle String sınıfına yapılan bir başvuru şu şekilde tam nitelikli olarak temsil edilir:
java.lang.Dize (kullanarak uygun dokümantasyon setine bağlanmadığınız sürece -Link)
çünkü dokümantasyon setinin bir parçası değil. belirtebilirsiniz -niteleyici
java.lang aynı referansları aynen vermek için dizi.

Tüm niteliksiz sınıf adları için, sınıfınızı yerleştirdiğinizde bir araç ipucunun sağlandığını unutmayın.
HTML belgelerinde fare işaretçisini bunun üzerine getirin.

-niteleyici herşey
Tüm sınıf adlarından paket adı niteleyicisini çıkar.

Paket adı niteleyicilerini tamamen atlamak için bu seçeneği belirtin,

Seçilmesi hangi Bilgi için Oluşturmak

-halka açık
Çıktıya yalnızca genel sınıfların genel üyelerini dahil edin. Varsayılan olarak, korumalı
sınıf üyeleri de dahildir.

korumalı
Çıktıya genel veya korumalı ortak sınıf üyelerini dahil edin. bu
Varsayılan.

-paket
Public ve paket-private'in public, protected ve paket-özel üyelerini dahil edin
sınıflar.

-özel
Erişim düzeylerine bakılmaksızın tüm sınıfları ve sınıf üyelerini dahil edin.

-splitindex
Tek bir yekpare dizin sayfası yerine harf başına bir dizin sayfası oluşturun.

Varsayılan olarak, Standard Doclet tarafından oluşturulan dizin, tek bir dosyadaki tüm girişleri içerir.
sayfa. Bu, küçük belge kümeleri için uygundur, ancak büyük kümeler için
bu seçeneği belirtin.

-o zamandan beri
aldırmamak @dan beri javadoc yorumlarındaki etiketler.

Varsayılan olarak, oluşturulan çıktı, API'nizin sürümünü listeleyen bölümleri içerir.
bu etiket olduğunda söz konusu paket, sınıf veya sınıf üyesi var olduğundan
karşılaşıldı. Bu bilgiyi atlamak için bu seçeneği belirtin.

-notree
Herhangi bir ağaç sayfası oluşturmayın.

Varsayılan olarak, oluşturulan çıktı paket başına bir kalıtım ağacı içerir ve - eğer
dokümantasyon seti birden çok paketten oluşur - tam kalıtımın olduğu bir sayfa
ağaç. Bu sayfaların oluşturulmasını atlamak için bu seçeneği belirtin.

-noindex
Alfabetik indeks çıktısı vermeyin.

Varsayılan olarak, gjdoc dizindeki tüm program öğelerinin alfabetik bir dizinini oluşturur.
dokümantasyon seti (paketler, sınıflar, iç sınıflar, kurucular, yöntemler ve
alanlar). Bu bilgiyi atlamak için bu seçeneği belirtin.

-yardım yok
Yardım sayfasını oluşturmayın.

Standart Belge bir yardım sayfası sağlamadığından bu seçenek şu anda yok sayılmaktadır.

-nodeprecated
Kullanımdan kaldırılan paketler, sınıflar veya sınıf üyeleri hakkında satır içi bilgi çıktısı vermeyin.

Varsayılan olarak, Standart Belge, kullanımdan kaldırılmış vurgulanmış bir paragraf ekler
kullanımdan kaldırılan her program öğesinin açıklamasına bilgi. Bunu belirtin
Bu bilgiyi atlamak için seçenek.

-nodeprecatedlist
Kullanımdan kaldırılan API öğeleri için özet sayfasını çıktılamayın.

Varsayılan olarak, Standart Belge, kullanımdan kaldırılmış tüm API öğelerini listeleyen bir sayfa oluşturur.
genellikle kullanımdan kaldırma nedenini içeren bir kullanımdan kaldırma açıklamasıyla birlikte
ve olası alternatifler. Bu bilgiyi atlamak için bu seçeneği belirtin.

-nonavbar
Gezinti çubuğunun, üstbilginin ve altbilginin çıktısını vermeyin.

Varsayılan olarak, her çıktı sayfası bir üst gezinme çubuğuyla donatılmıştır (bunlar şunları içerebilir:
kullanıcı tanımlı bir başlık) ve bir alt gezinme çubuğu (bir kullanıcı
belirtilen altbilgi). Bu dekorasyonu atlamak için bu seçeneği belirtin.

-yorum yok
Oluşturulan dosyalardan tüm belge metnini çıkarın ve yalnızca beyanları çıktılayın ve
program öğesi ilişkileri.

Bu seçenek, uyumluluk için burada javadoc. çıkarmayı planlıyorsanız
aracılığıyla projeniz hakkında bilgi gjdoc, farklı bir Doclet kullanmayı düşünmelisiniz
bunun yerine amaçlarınız için, örneğin XmlDoclet. Doclet API'sini de kullanabilirsiniz
doğrudan yeni bir Doclet uygulayarak.

-bağlantı kaynağı
Her sınıf için sözdizimi vurgulanmış kaynak koduna sahip bir sayfa oluşturun. Varsayılan olarak, bu
sayfa oluşturulmaz.

Kaynak koduna, “Kaynak” etiketli buton tıklanarak erişilebilir.
gezinme çubuğu veya bir kurucu, alan, yöntem veya iç ismin üzerine tıklayarak
sınıf belgeleri sayfasının ayrıntı bölümündeki sınıf.

-kullanır
Çapraz referans bilgileri içeren bir sayfa oluşturun. Varsayılan olarak, bu sayfa
oluşturuldu.

Çapraz referans bilgilerine etiketli butona tıklayarak ulaşılabilir.
Gezinme çubuğunda 'Kullan'.

'Kullanım' sayfası, belge kümesindeki tüm sınıfları/arayüzleri listeler.
söz konusu sınıfı (türü) genişletin/uygulayın; türün alanları; yöntemler veya
tipin bir parametresini kabul eden yapıcılar; türü döndüren yöntemler; ve
türü atan yöntemler veya yapıcılar.

-yazar
Çıktıya yazar bilgilerini dahil edin.

Belirtildiğinde, yazar bilgileri kullanılarak belirtildiği gibi @yazar javadoc'ta etiket
yorumlar çıktıya dahil edilir. Varsayılan olarak, @yazar etiketler yoksayılır.

-version
Çıktıya sürüm bilgilerini dahil edin.

Belirtildiğinde, sürüm bilgileri kullanılarak belirtildiği şekilde @versiyon javadoc'ta etiket
yorumlar çıktıya dahil edilir. Varsayılan olarak, @versiyon etiketler yoksayılır.

-lisans metni
Her kaynak dosyadaki ilk yorumun lisans metnini içerdiğini varsayalım ve
oluşturulan her sınıf sayfasının alt bilgisine lisans bilgileri.

Bu, belirli bir seçenek gjdoc ve Sun ile uyumlu değil javadoc.

Bu seçenek, kaynak kodunun kullanıldığı ücretsiz ve açık kaynaklı projelerde kullanılmak üzere tasarlanmıştır.
yasal nedenler olduğunda, tipik olarak bir standart lisans yorumu ile öneklenir
lisansı belgelere dahil etmek için.

-docfilessubdirs
içindeki tüm dosyaları tekrar tekrar kopyalayın. belge dosyaları her paket dizininin alt dizini.

Genellikle, yalnızca içindeki dosyalar belge dosyaları alt dizin inmeden kopyalanır
tekrarlı.

-hariç tutulan belge dosyaları alt dizini isim:isim...
Bazı dizinleri doğrudan dizinin altına kopyalamayın. belge dosyaları alt dizinler ne zaman
yinelemeli olarak azalan.

Bu seçeneğin argümanı, iki nokta üst üste ayrılmış bir dizin adları listesi olmalıdır.

Bu seçenek yalnızca şu durumlarda anlamlıdır: -docfilessubdirs da belirtilir. Bu durumda, herhangi bir
doğrudan altında bulunan alt dizin belge dosyaları listelenirse dizin atlanır.

görenek belgeleme Etiketler

-etiket yolu yol listesi
Ara yol listesi kullanılarak belirtilen sonraki Taglet sınıflarını yüklerken -etiket.

yol listesi ile ayrılmış bir dizine veya jar dosyasına giden bir veya daha fazla yol olmalıdır.
platformun yol ayırıcısı (genellikle : or ;).

-etiket sınıfadı
Bir Taglet'i kaydedin.

sınıfadı uygulayan bir Java sınıfının tam nitelikli adı olmalıdır
com.sun.tools.doclets.Taglet.

Taglet sınıfları, kullanılarak belirtilen sınıf yolundan yüklenecektir. -etiket yolu, Dan
kullanılarak belirtilen sınıf yolu -sınıf yolu ve varsayılan sınıf yolundan.

belgelerine bakın com.sun.tools.doclets.Taglet daha fazla bilgi için.

Basit etiketler için ayrıca -etiket.

-etiket etiket belirtimi
Genel bir Taglet kaydedin.

Formatı etiket belirtimi olmalı : :" ".

etiket adı baştaki @ işareti olmadan eşleştirilecek etiket adıdır.

bayraklar aşağıdaki karakterlerden biri veya daha fazlasıdır, burada her karakter bir
etiketin tanınacağı kaynak kod bağlamı.

a tüm bağlamlar

c kurucular

f alanları

m yöntemleri

o genel bakış

p paketler

t türler (sınıflar, arayüzler, istisnalar, hatalar)

X Taglet'i geçici olarak tamamen devre dışı bırakan özel karakter.

etiket kafası etikete ayrılmış bölümün başlığında görüntülenecek dizedir.
soru.

Örneğin, bir etiket eşleştirmesi tanımlamak için @cvsid genel olarak kabul edilecek olan,
paket ve tip sayfaları ve başlıkla etiketlenmiş CVS ID, yapabilirdin
belirtmek:

-etiket cvsid:tpo:"CVS Kimliği"

Diyelim ki bir sınıf javadoc yorumu şunları içeriyor:

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

Sonra HTML çıktısı gibi bir şey içerecektir

CVS Kimliği:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Tecrübe $

Koşu Diğer belgeler

-docletyolu yol listesi
Ara yol listesi kullanılarak belirtilen Doclet için sınıfları yüklerken -belge.

yol listesi ile ayrılmış bir dizine veya jar dosyasına giden bir veya daha fazla yol olmalıdır.
platformun yol ayırıcısı (genellikle : or ;).

-belge sınıf adı
Standart HtmlDoclet yerine belirtilen dokümanı çalıştırın.

sınıf adı genel varsayılanı olan bir sınıfın tam nitelikli adı olmalıdır
yapıcı ve aşağıdaki imzaya sahip bir yöntem içerir:

com.sun.javadoc.RootDoc'u içe aktarın;
genel statik boole başlangıç ​​(RootDoc ​​rootDoc)

Doclet sınıfları, kullanılarak belirtilen sınıf yolundan yüklenecektir. -docletyolu, Dan
kullanılarak belirtilen sınıf yolu -sınıf yolu ve varsayılan sınıf yolundan.

The başlama yöntem, Doclet API tarafından sunulan bilgileri şu şekilde işlemelidir: kökDoc
ve dönüş gerçek başarı üzerine, yanlış başarısızlık üzerine.

Üçüncü taraf bir belge kullanıyorsanız, daha fazla bilgi için belgelerine bakın.
Talimatlar. Üçüncü taraf dokümanlar için desteğin deneysel olduğunu unutmayın. Lütfen
karşılaştığınız sorunları bildirin veya başarıyla çalıştırırken geri bildirim sağlayın
üçüncü taraf uygulamaları.

Bu seçenek birden çok kez belirtilebilir, bu durumda tüm dokümanlar yürütülür.
her Doclet çalıştırması için Doclet API aracılığıyla sunulan aynı bilgi ağacıyla.

Ekleme Bilgi için the Çıktı

-pencere başlığı metin
kullanım metin tarayıcı penceresi başlık öneki olarak.

Belirtildiğinde, her sayfanın tarayıcı penceresi başlığının önüne şu şekilde eklenecektir: metin
varsayılan dize yerine oluşturulan API belgeleme.

metin düz metin olmalıdır (HTML etiketleri içermemelidir).

-belge başlığı metin
Genel bakış sayfasının başlık metnini şu şekilde ayarlayın: metin.

metin kısa bir düz metin dizesi olmalıdır.

Tek bir paket için dokümantasyon oluştururken, bu seçeneğin belirtilmesi,
genel bakış sayfasının oluşturulması.

-başlık htmlmetin
Ekle htmlmetin oluşturulan her sayfanın sağ üst köşesine. htmlmetin genellikle
belgelenen projenin adına ayarlayın.

-altbilgi htmlmetin
Ekle htmlmetin oluşturulan her sayfanın sağ alt köşesine. htmlmetin sıksıktır
ile aynı değere ayarlayın -başlık.

-alt htmlmetin
Ekle htmlmetin tüm genişliğini kapsayan, oluşturulan her sayfanın en altına
sayfa. Belirtildiğinde, htmlmetin genellikle bir telif hakkı bildiriminden ve/veya
diğer proje sayfalarına bağlantılar.

-eklenti sayfası dosya
Kullanıcı tanımlı stil sayfasıyla varsayılan CSS stil sayfalarını artırın dosya.

Verilen stil sayfası, varsayılana ek olarak her HTML sayfası tarafından basitçe yüklenir.
olanlar, son stil sayfası olarak.

CSS basamaklandırma kurallarının geçerli olduğunu unutmayın. Yani, stil özellikleriniz yalnızca
daha yüksek bir basamaklı sıraya sahiplerse atanır gjdocvarsayılan stil. basit bir
Durumun böyle olduğundan emin olmanın yolu, geçersiz kılmalarınızı bildirmektir. !önemli.

Görmekhttp://www.w3.org/TR/REC-CSS2/cascade.html#basamaklı-sipariş>.

-grubu başlık pkgwildcard:pkgwildcard...
Genel bakış sayfasında verilen paketleri ayrı bir grup halinde düzenleyin.

İlk argüman, makalenin başlığı olarak kullanılan kısa bir düz metin olmalıdır.
paket grubu. İkinci argüman, iki nokta üst üste ile ayrılmış bir paket listesi olmalıdır.
joker karakterler. Grup, dokümantasyon setinde adı geçen tüm paketlerden oluşacaktır.
verilen joker karakterlerden herhangi biriyle eşleşir.

Yalnızca bir joker karakter vardır, *, paket adındaki her iki harfle de eşleşen
bileşenler ve . paket adı bileşenlerini ayırma. Örneğin, j*normal ifade olur
maç paketi java.util.regex. Daha kullanışlı bir örnek javax.swing* maç
javax.swing ve tüm alt paketleri.

Bu seçenek birden çok kez verilebilir.

FIXME: Burada grup yerleştirme hakkında bilgi.

gjdoc -group "Temel Sınıflar" 'java*' \
-grup "Swing" 'javax.swing*' \
-grup "XML API'leri" 'javax.xml*' \
-grup "Diğer Uzantılar" javax* \
...

-genel bakış dosya
XHTML gövde parçasını şuradan ekleyin: dosya genel bakış sayfasına gidin.

dosya HTML ile bir XHTML parçası içermelidir vücut kök düğüm olarak etiketleyin.

Bu seçenek, bir bütün olarak dokümantasyon setinin bir tanımını sağlamak için kullanılabilir.

Belirtildiğinde, parçanın ilk cümlesi tabloların üzerine konacaktır.
parçanın tam kopyasına bir bağlantı ile birlikte belgelenmiş paketleri listeleme
hangi tabloların altına konur.

Tek bir paket için dokümantasyon oluştururken, bu seçeneğin belirtilmesi,
genel bakış sayfasının oluşturulması.

-stil sayfası dosyası dosya
CSS stil sayfasını şurada kullanın: dosya varsayılan CSS stil sayfaları yerine.

Yalnızca varsayılan stil sayfalarının bölümlerini geçersiz kılmak istiyorsanız, şunu kullanın: -eklenti sayfası
yerine.

-Başlık metin
Kullanımdan kaldırıldı. kullanım -belge başlığı metin yerine.

-yardım dosyası dosya
Bu seçenek şu anda yok sayılıyor.

Uygulandığında, içinde XHTML parçasını kullanır. dosya yardım sayfası içeriği için
varsayılan yardım metni yerine.

Denetleme the Çıktı.

-d rehber
Tüm çıktı dosyalarını içine yerleştirin rehber (ve alt dizinler). rehber yaratılacak
mevcut değilse, mevcut olmayan tüm üst dizinler ve gerekli tüm dizinler dahil
alt dizinler.

Belirtilmezse, çıktı geçerli dizine yerleştirilecektir.

-yerel isim
Yerel ayarı kullan isim tüm amaçlar için varsayılan yerel ayar yerine.

isim formda bir yerel ayar belirteci olmalıdır ll_CC[_VAR] nerede ll küçük harf iki-
harf ISO-639 dil kodu, CC isteğe bağlı bir büyük harfli iki harfli ISO-3166 ülkesidir
kod ve VAR isteğe bağlı bir değişken kodudur. Örneğin, en İngilizce belirtir, tr
ABD İngilizcesini belirtir ve tr_US_WIN ABD İngilizcesinin sapkın bir türevini belirtir
yerel.

Bu seçeneğin semantiğinin tam olarak kurucuların anlambilimine karşılık geldiğine dikkat edin.
sınıfın java.util.Yerel.

Bu seçenek şu anda yalnızca çıktıyı sıralamak için hangi Harmanlayıcının kullanıldığını belirler
elementler. Bu, yerel ayarın yalnızca aşağıdakileri kullandığınızda etkili olacağı anlamına gelir.
Tanımlayıcılardaki ASCII karakterleri.

-karakter seti karakter kümesi
Kullanımdan kaldırıldı. Çıktı XHTML dosyalarında belirtilen kodlamayı verilenle geçersiz kıl
by karakter kümesi.

Bu seçenek verilmezse, XHTML çıkışındaki kodlama özelliği şu şekilde seçilir:
dosyayı yazarken kullanılan kodlamayı eşleştirin (ile verilen kodlama -dosya kodlama,
veya platformunuzun varsayılan kodlaması).

için anlambilim karakter kümesi burada belirtilir:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncAdı>. Tüm pratik amaçlar için,
karakter kümesi parametrelerini kabul eden diğer seçeneklerle aynıdır.

Bu seçenek, uyumluluk için burada javadoc ve kaçınılmalıdır.

-dosya kodlama karakter kümesi
Çıktı dosyalarını yazarken platformunuzunkiler yerine verilen karakter kümesi kodlamasını kullanın.
varsayılan kodlama

İçin örnekler karakter kümesi vardır US-ASCII, ISO-8859-1 or UTF-8.

Bu seçeneğin semantiği, tam olarak sınıfın kurucularınınkine karşılık gelir.
java.util.Yerel.

-geçerlihtml
Geçerli XHTML kodunun oluşturulmasını zorunlu kılın. Bu gelenekselle uyumluluğu bozar
Javadoc aracı bir dereceye kadar.

Bu seçenek belirtilirse, geçerli olmaları için bağlantı adları değiştirilir.
XHTML 1.1 spesifikasyonuna göre. Bununla birlikte, ile oluşturulan bir dokümantasyon seti
bu seçenek, geleneksel Javadoc aracı kullanılarak düzgün şekilde ilişkilendirilemez. Yapabilir
yine de Gjdoc kullanarak iyi bir şekilde bağlantılı olun.

Bu seçenek olmadan, yürütülebilir sınıf üyeleri için bağlantı adları geleneksel
format, örneğin: "foo(String,int[])". Bu geleneksel ile uyumludur
Javadoc aracı, ancak hem HTML 4.0 hem de XHTML 1.0 ve 1.1 özelliklerine göre,
bu biçim geçersiz karakterler içerir. Parantezler, köşeli parantezler ve virgül
çapa adlarında izin verilmez.

-baseurl url
Bir sayfa URL'sini şuna göre sabitleyin: url oluşturulan her sayfaya.

Yalnızca belirli bir tarihte mevcut olacak belgeler oluşturuyorsanız,
URL, bu URL'yi belirtmek için bu seçeneği kullanmalısınız.

Bu, spam gönderenler tarafından kullanılan belirli yönlendirme saldırılarından kaçınmaya yardımcı olabilir ve yardımcı olabilir
belirli web istemcileri için.

lâf salatası Opsiyonlar

-sessiz
Uyarılar ve hata mesajları dışındaki tüm çıktıları bastırın.

-ayrıntılı
Ne hakkında çok ayrıntılı olun gjdoc yapıyor.

Bu seçenek şu anda yok sayılıyor.

Sanal makine Opsiyonlar

Güneş en javadoc araç dayalı gibi görünüyor javac ve bu nedenle VM'de çalışıyor gibi görünüyor
seviye. gjdoc, aksine, saf bir Java uygulamasıdır.

Bu nedenle, gjdoc yalnızca aşağıdaki VM düzeyindeki seçenekleri taklit edebilir veya simüle edebilir.

-sınıf yolu yol listesi
Sanal Makineyi Ayarlayın sınıf yolu için yol listesi.

Çoğu durumda kullanmalısınız -docletyolu or -etiket yolu Bu seçenek yerine.

yol listesi ile ayrılmış bir dizine veya jar dosyasına giden bir veya daha fazla yol olmalıdır.
platformun yol ayırıcısı (genellikle : or ;).

Bu seçenek sarmalayıcı düzeyinde engellenmezse, gjdoc şu anda onu taklit ediyor
çağrı System.setProperty("java.class.path", yol listesi); ve bir uyarı verir.

-önyükleme sınıfı yolu yol listesi
Sanal Makineyi Ayarlayın önyükleme sınıfı yolu için yol listesi.

Bu seçenek sarmalayıcı düzeyinde engellenmezse, gjdoc bir uyarı verir.

-Jvmopt
Sanal Makineye rastgele bir parametre iletin gjdoc çalışır.

Bu seçenek sarmalayıcı düzeyinde engellenmezse, gjdoc öykünmeye çalışır
seçeneği ve bir uyarı verir.

Şu anda yalnızca VM seçeneği -D sistem özelliklerini ayarlamak için öykünür.

onworks.net hizmetlerini kullanarak gjdoc-4.8'i çevrimiçi kullanın