gjdoc-4.8 - Online sa Cloud

PROGRAMA:

NAME

cp-tools - Gabay sa GNU Classpath Tools

SINOPSIS

gjdoc [-sourcepath pathlist]
[-lahat] [-mga subpackage pkg:pkg:...] [- ibukod pkglist]
[-encoding charset] [-lokal pangalan] [-pinagmulan pakawalan]
[-pampubliko] [-protektado] [-pakete] [-pribado]
[-doctitle teksto] [-header teksto] [-footer teksto] [-baba teksto]
[-Link url] [-linkoffline url landas] [-noqualifier pkg:pkg:...]
[-tagletpath pathlist] [-taglet pangalan ng klase] [-tag tagspec]
[-paggamit] [-linksource] [-splitindex] [-noindex] [-notree]
[-version] [-isang akda] [-nosince] [-addstylesheet file]
[-d targetdir]
[pakete...] [sourcefiles...] [@cmdfile]

gjdoc [-sourcepath pathlist]
[-lahat] [-mga subpackage pkg:pkg:...] [- ibukod pkglist]
[-encoding charset] [-lokal pangalan] [-pinagmulan pakawalan]
[-pampubliko] [-protektado] [-pakete] [-pribado]
[-docletpath pathlist] [-doclet pangalan ng klase]
[pakete...] [sourcefiles...] [@cmdfile]
[mga pagpipilian sa dokumento]

gjdoc - Tumulong

gjdoc --bersyon

Ang mga pinakakapaki-pakinabang na opsyon lamang ang nakalista dito; tingnan sa ibaba para sa natitira.

DESCRIPTION

Maaaring gamitin ang Gjdoc sa dalawang paraan: bilang isang stand-alone na tool sa dokumentasyon, o bilang isang driver para sa a
Doclet na tinukoy ng gumagamit.

Sa default na mode, gagamitin ni Gjdoc ang Standard Doclet HtmlDoclet upang makabuo ng isang set ng
Mga pahina ng HTML. Ang canonical na paggamit ay:

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

Dito, src/java/ ay ang ugat ng iyong source code class hierarchy, -lahat ibig sabihin valid lahat
Ang mga Java file na matatagpuan sa ilalim ng root directory na ito ay dapat maproseso, at api-docs/ ay ang
direktoryo kung saan dapat ilagay ang nabuong dokumentasyon.

Upang matuto nang higit pa tungkol sa pagpapatakbo ng Doclets maliban sa Standard Doclet, sumangguni sa manual.

Opsyon

Opsyon Buod by uri

Narito ang isang buod ng lahat ng mga opsyon ng parehong Gjdoc at ang Standard Doclet, na nakapangkat ayon sa
uri. Ang mga paliwanag ay nasa mga sumusunod na seksyon.

pinagmulan Itakda Options
-sourcepath pathlist -mga subpackage pkglist - ibukod pkglist

pinagmulan format Options
-pinagmulan pakawalan -encoding pag-encode -breakiterator

Pag-uugnay Options
-Link url -linkoffline url file -noqualifier pkg:pkg:...

Henerasyon Options
-isang akda -teksto ng lisensya -paggamit -version -splitindex -noindex
-nodeprecated -nodeprecatedlist -walang tulong -nonavbar
-nosince -notree -pampubliko -protektado -pakete -pribado
-docfilessubdirs -excludedocfilessubdir diname
-linksource

Pagbubuhos Options
-d -lokal pangalan -charset charset -docencoding charset
-validhtml -baseurl url

Medalya Options
-pamagat ng bintana teksto -doctitle teksto -pamagat teksto
-header teksto -footer teksto -baba teksto
-helpfile file -stylesheetfile file -addstylesheet file
-pangkat groupheading pkgpattern:pkgpattern:...

Taglet Options
-tagletpath -taglet pangalan ng klase -tag tagspec

Doclet Options
-docletpath -doclet pangalan ng klase

Verbosity Options
-tahimik -salita

Totoo Makina Options
-classpath -bootclasspath -J vmopt

Ang pagpili alin pinagmulan File sa paraan

-s pathlist
-sourcepath pathlist
Maghanap ng mga source file sa tinukoy na direktoryo o mga direktoryo.

pathlist dapat isa o higit pang mga path ng direktoryo na pinaghihiwalay ng landas ng iyong platform
separator (karaniwan : or ;).

Kung ang pagpipiliang ito ay hindi ibinigay, gjdoc ay maghahanap ng mga source file sa kasalukuyang
direktoryo.

Ang mga tinukoy na direktoryo ay dapat na mga direktoryo ng ugat sa mga tuntunin ng Java package
sistema. Halimbawa, kung gusto mong bumuo ng dokumentasyon para sa mga klase sa package
foo.bar, dapat mong tukuyin ang direktoryo na naglalaman ng pinakamataas na antas foo sub-direktoryo,
hindi ang direktoryo foo/bar/ kung saan nakatira ang mga Java source file.

Ang short-hand alias -s ay tiyak sa gjdoc at hindi tugma sa Sun javadoc.

-lahat
[EXPERIMENTAL] Iproseso ang lahat ng wastong Java source file na makikita sa mga direktoryo na nakalista sa
ang source path at ang kanilang mga sub-directory.

Isa itong opsyong partikular sa gjdoc at hindi tugma sa Sun javadoc.

-mga subpackage pkg:pkg:...
Iproseso ang mga klase sa ibinigay na Java packages at lahat ng sub-package, nang paulit-ulit.
Tandaan na ang maraming pangalan ng package ay dapat paghiwalayin ng mga colon sa halip na whitespace.

- ibukod pkg:pkg:...
Huwag iproseso ang mga klase sa ibinigay na Java packages at lahat ng sub-package, nang paulit-ulit.
Maaaring gamitin ang pagpipiliang ito kasabay ng -lahat or -mga subpackage upang ibukod
indibidwal na mga pakete o mga sub-puno ng pakete mula sa output.

pakete...
Iproseso ang lahat ng mga klase sa ibinigay na mga pakete ng Java.

sourcefiles...
Iproseso ang mga klase sa ibinigay na Java source file.

Tinutukoy ang format of input File

-pinagmulan pakawalan
Ipagpalagay na ang mga source file ay naka-target sa ibinigay na release ng Java platform.

pakawalan dapat ay ang numero ng bersyon ng isang release ng platform ng Java sa format
MAJOR.MINOR, halimbawa 1.4.

Kasalukuyang binabalewala ang opsyong ito maliban na ang isang error ay nakataas kung ang isang release number
bukod sa 1.2, 1.3 or 1.4 ay tinukoy.

-encoding charset
Ipagpalagay na ang mga source file ay naka-encode gamit charset.

Mga halimbawa para sa charset ay US-ASCII, ISO-8859-1 or UTF-8.

Ang semantika ng charset ay kapareho ng sa
java.nio.charset.Charset.forName(String).

-breakiterator
Gamitin ang java.text.BreakIterator ng lokal sa halip na ang panloob na unang pangungusap
detektor

Sa pamamagitan ng default, gjdoc gumagamit ng panloob na algorithm upang matukoy kung saan nagtatapos ang isang pangungusap. Kailan
ibinigay ang opsyong ito, sa halip ay gagamitin nito ang java.text.BreakIterator halimbawa para sa
lokal na ibinigay kasama ng -lokal (o ang default na lokal).

Dapat tukuyin ang opsyong ito kapag nag-aaplay gjdoc sa source code na nagkomento sa isang hindi-
wikang latin kung saan hindi gumagana ang default na first sentence detector. Para sa lahat
ibang mga kaso, ang default (huwag gumamit ng BreakIterator) ay gumagawa ng mas mahusay na mga resulta sa
panahon ng pagsulat na ito.

Pag-uugnay sa iba dokumentasyon Sets

-Link url
Lumikha ng mga hyperlink sa isa pang hanay ng dokumentasyon.

Sa pamamagitan ng default, gjdoc lilikha lamang ng mga hyperlink sa mga klase sa source set. Gamitin mo to
opsyon na dagdag na lumikha ng mga hyperlink sa mga klase na sakop ng tinukoy
set ng dokumentasyon.

url dapat ang root URL ng iba pang hanay ng dokumentasyon. Halimbawa, upang magdagdag
hyperlink sa GNU Classpath, tukuyin ang sumusunod:

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

Ang -Link ang opsyon ay maaaring tukuyin ng maraming beses.

Tandaan na ang pagtukoy sa -Link ang opsyon ay magdudulot ng HTTP access sa tuwing ang gjdoc ay
hinihingi. Pwede mong gamitin -linkoffline sa halip upang maiwasan ang pag-access na ito.

-linkoffline url file
Lumikha ng mga hyperlink sa isa pang hanay ng dokumentasyon na naroroon din sa lokal na file
system.

Ang pagpipiliang ito ay gumagana nang eksakto tulad ng -Link, maliban na ina-access nito ang lokal na file system
sa halip na ang network para sa pagtukoy kung aling mga klase ang sakop ng naka-link
set ng dokumentasyon.

Kapag gumagamit -linkoffline ang remote na hanay ng dokumentasyon ay hindi na-access sa lahat, na maaari
makabuluhang mapabilis ang oras ng pagbuo depende sa iyong koneksyon sa network. Ang
nakabuo ng mga hyperlink sa set ng dokumentasyon gayunpaman ay sumangguni sa remote set, hindi sa
ang lokal, upang maipamahagi mo ang dokumentasyon nang wala nang iba pa
dependencies.

Ang -linkoffline ang opsyon ay maaaring tukuyin ng maraming beses.

-noqualifier pkg:pkg:...
Huwag gawing kwalipikado ang mga pangalan ng mga klase sa ibinigay na mga pakete kasama ang kanilang pangalan ng package.

Bilang default, ang isang pangalan ng klase ay ipinapakita na hindi kwalipikado lamang kung ang klase ay bahagi ng
source set o isang naka-link na set ng dokumentasyon, at kwalipikado sa pangalan nito
naglalaman ng pakete kung hindi. Magagamit mo ang opsyong ito para pilitin ang mga hindi kwalipikadong pangalan
para sa mga klase kahit na hindi sila bahagi ng set ng dokumentasyon.

Halimbawa, kadalasan ang isang sanggunian sa klase ng String ay kinakatawan na ganap na kwalipikado bilang
java.lang.String (maliban kung mag-link ka sa naaangkop na hanay ng dokumentasyon gamit ang -Link)
dahil hindi ito bahagi ng hanay ng dokumentasyon. Maaari mong tukuyin -noqualifier
java.lang upang ibigay ang parehong mga sanggunian tulad ng Pisi.

Tandaan na para sa lahat ng hindi kwalipikadong pangalan ng klase, may ibibigay na tooltip kapag inilagay mo ang iyong
mouse pointer sa ibabaw nito sa HTML na dokumentasyon.

-noqualifier lahat
Alisin ang qualifier ng pangalan ng package sa lahat ng pangalan ng klase.

Tukuyin ang opsyong ito upang ganap na alisin ang mga qualifier ng pangalan ng package,

Ang pagpili alin Impormasyon sa lumikha

-pampubliko
Isama lamang ang mga pampublikong miyembro ng mga pampublikong klase sa output. Bilang default, protektado
kasama na rin ang mga miyembro ng klase.

-protektado
Isama ang pampubliko o protektadong miyembro ng mga pampublikong klase sa output. Ito ang
default.

-pakete
Isama ang pampubliko, protektado at package-private na miyembro ng publiko at package-private
mga klase.

-pribado
Isama ang lahat ng klase at miyembro ng klase anuman ang antas ng kanilang pag-access.

-splitindex
Bumuo ng isang pahina ng index bawat titik sa halip na isang solong, monolitikong pahina ng index.

Bilang default, ang index na ginawa ng Standard Doclet ay naglalaman ng lahat ng mga entry sa isang solong
pahina. Ito ay mainam para sa maliliit na hanay ng dokumentasyon, ngunit para sa malalaking hanay dapat mo
tukuyin ang opsyong ito.

-nosince
Huwag pansinin @simula mga tag sa mga komento ng javadoc.

Bilang default, ang nabuong output ay naglalaman ng mga seksyon na naglilista ng bersyon ng iyong API
kung saan umiiral ang package, klase o miyembro ng klase na pinag-uusapan kapag ang tag na ito ay
nakatagpo. Tukuyin ang opsyong ito upang alisin ang impormasyong ito.

-notree
Huwag bumuo ng anumang mga pahina ng puno.

Bilang default, ang nabuong output ay may kasamang isang inheritance tree bawat package, at - kung
ang hanay ng dokumentasyon ay binubuo ng maraming mga pakete - isang pahina na may buong mana
puno. Tukuyin ang opsyong ito upang alisin ang pagbuo ng mga pahinang ito.

-noindex
Huwag i-output ang alphabetical index.

Bilang default, bumubuo ang gjdoc ng alphabetical index ng lahat ng elemento ng program sa
set ng dokumentasyon (mga pakete, klase, panloob na klase, konstruktor, pamamaraan, at
mga patlang). Tukuyin ang opsyong ito upang alisin ang impormasyong ito.

-walang tulong
Huwag bumuo ng pahina ng tulong.

Kasalukuyang binabalewala ang opsyong ito dahil ang Standard Doclet ay hindi nagbibigay ng pahina ng tulong.

-nodeprecated
Huwag maglabas ng inline na impormasyon tungkol sa mga hindi na ginagamit na mga pakete, klase o miyembro ng klase.

Bilang default, ang Standard Doclet ay nagdaragdag ng isang naka-highlight na talata na may paghinto sa paggamit
impormasyon sa paglalarawan ng bawat hindi na ginagamit na elemento ng programa. Tukuyin ito
opsyon na alisin ang impormasyong ito.

-nodeprecatedlist
Huwag i-output ang pahina ng buod para sa mga hindi na ginagamit na elemento ng API.

Bilang default, bumubuo ang Standard Doclet ng page na naglilista ng lahat ng hindi na ginagamit na elemento ng API
kasama ng paglalarawan ng paghinto sa paggamit na kadalasang kinabibilangan ng dahilan ng paghinto sa paggamit
at posibleng mga alternatibo. Tukuyin ang opsyong ito upang alisin ang impormasyong ito.

-nonavbar
Huwag i-output ang navigation bar, header, at footer.

Bilang default, ang bawat pahina ng output ay nilagyan ng nangungunang navigation bar (na maaaring kabilang ang
isang header na tinukoy ng user) at isang navigation bar sa ibaba (na maaaring kabilang ang isang user-
tinukoy na footer). Tukuyin ang opsyong ito upang alisin ang dekorasyong ito.

-nocomment
Alisin ang lahat ng teksto ng dokumentasyon mula sa mga nabuong file at mga deklarasyon lamang ang output at
mga ugnayan ng elemento ng programa.

Narito ang opsyong ito para sa pagiging tugma sa javadoc. Kung plano mong mag-extract
impormasyon tungkol sa iyong proyekto sa pamamagitan ng gjdoc, dapat mong isaalang-alang ang paggamit ng ibang Doclet
para sa iyong mga layunin sa halip, halimbawa XmlDoclet. Maaari mo ring gamitin ang Doclet API
direkta sa pamamagitan ng pagpapatupad ng bagong Doclet.

-linksource
Bumuo ng isang pahina na may naka-highlight na syntax na source code para sa bawat klase. Bilang default, ito
hindi nabuo ang pahina.

Maaaring ma-access ang source code sa pamamagitan ng pag-click sa button na may label na "Source" sa
navigation bar, o sa pamamagitan ng pag-click sa pangalan ng isang constructor, field, method, o inner
klase sa seksyong detalye ng isang pahina ng dokumentasyon ng klase.

-paggamit
Bumuo ng isang pahina na may cross-reference na impormasyon. Bilang default, ang page na ito ay hindi
nabuo

Maaaring ma-access ang cross-reference na impormasyon sa pamamagitan ng pag-click sa button na may label
`Gamitin' sa navigation bar.

Ang pahina ng `Gamitin' ay naglilista ng lahat ng mga klase/interface sa set ng dokumentasyong iyon
palawakin/ipatupad ang klase (uri) na pinag-uusapan; mga patlang ng uri; pamamaraan o
tumatanggap ang mga konstruktor ng isang parameter ng uri; mga pamamaraan na nagbabalik ng uri; at
pamamaraan o constructor na ibinabato ang uri.

-isang akda
Isama ang impormasyon ng may-akda sa output.

Kapag tinukoy, impormasyon ng may-akda gaya ng tinukoy gamit ang @may-akda tag sa javadoc
Ang mga komento ay isinama sa output. Bilang default, @may-akda hindi pinapansin ang mga tag.

-version
Isama ang impormasyon ng bersyon sa output.

Kapag tinukoy, ang impormasyon ng bersyon gaya ng tinukoy gamit ang @bersyon tag sa javadoc
Ang mga komento ay isinama sa output. Bilang default, @bersyon hindi pinapansin ang mga tag.

-teksto ng lisensya
Ipagpalagay na ang unang komento sa bawat source file ay naglalaman ng teksto ng lisensya, at idagdag
impormasyon ng lisensya sa footer ng bawat nabuong page ng klase.

Isa itong opsyong partikular sa gjdoc at hindi tugma sa Sun javadoc.

Ang pagpipiliang ito ay inilaan para sa paggamit sa libre at open source na mga proyekto kung saan ang source code
ay karaniwang may prefix na komento sa lisensya ng boilerplate, kapag may mga legal na dahilan
para sa pagsasama ng lisensya sa dokumentasyon.

-docfilessubdirs
Recursively kopyahin ang lahat ng mga file sa mga doc-file sub-directory ng bawat direktoryo ng package.

Karaniwan, ang mga file lamang sa mga doc-file ang sub-directory ay kinopya nang hindi bumababa
recursively

-excludedocfilessubdir pangalan:pangalan: ...
Huwag kopyahin ang ilang direktoryo nang direkta sa ilalim ng mga doc-file mga sub-directory kapag
pababang pabalik-balik.

Ang argumento sa opsyong ito ay dapat na isang colon-separated list ng mga pangalan ng direktoryo.

Ang pagpipiliang ito ay makatuwiran lamang kung -docfilessubdirs ay tinukoy din. Sa kasong ito, anuman
sub-directory na matatagpuan direkta sa ilalim ng a mga doc-file ang direktoryo ay tinanggal kung nakalista.

Pasadya dokumentasyon Mga tag

-tagletpath pathlist
paghahanap pathlist kapag naglo-load ng mga kasunod na klase ng Taglet na tinukoy gamit -taglet.

pathlist ay dapat isa o higit pang mga path sa isang direktoryo o jar file, na pinaghihiwalay ng iyong
separator ng landas ng platform (karaniwan : or ;).

-taglet pangalan ng klase
Magrehistro ng Taglet.

pangalan ng klase dapat ang ganap na kwalipikadong pangalan ng isang Java class na nagpapatupad
com.sun.tools.doclets.Taglet.

Ang mga klase ng Taglet ay ilo-load mula sa classpath na tinukoy gamit -tagletpath, Mula
ang classpath na tinukoy gamit -classpath at mula sa default na classpath.

Tingnan ang dokumentasyon ng com.sun.tools.doclets.Taglet para sa karagdagang impormasyon.

Tandaan na para sa mga simpleng tag, mayroon din -tag.

-tag tagspec
Magrehistro ng generic na Taglet.

Ang format ng tagspec dapat : :" ".

tagname ay ang pangalan ng tag na tutugma, nang walang nangunguna na @ sign.

flag ay isa o higit pa sa mga sumusunod na character, kung saan tinutukoy ng bawat karakter ang a
konteksto ng source code kung saan kikilalanin ang tag.

a lahat ng konteksto

c tagapagtayo

f patlang

m pamamaraan

o pangkalahatang-ideya

p pakete

t mga uri (mga klase, interface, pagbubukod, mga error)

X espesyal na karakter na pansamantalang hindi pinagana ang Taglet nang buo.

taghead ay ang string na ipapakita sa header ng seksyong nakatuon sa tag sa
tanong.

Halimbawa, upang tukuyin ang isang tag na tumutugma @cvsid na dapat tanggapin sa pangkalahatang-ideya,
package at uri ng mga pahina at kung saan ay may label na may header CVS ID, gagawin mo
tukuyin:

-tag cvsid:tpo:"CVS ID"

Sabihin nating naglalaman ang isang komento ng class javadoc

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

Pagkatapos ang HTML na output ay naglalaman ng isang bagay tulad ng

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

Tumatakbo iba Doclets

-docletpath pathlist
paghahanap pathlist kapag naglo-load ng mga klase para sa Doclet na tinukoy gamit -doclet.

pathlist ay dapat isa o higit pang mga path sa isang direktoryo o jar file, na pinaghihiwalay ng iyong
separator ng landas ng platform (karaniwan : or ;).

-doclet pangalan ng klase
Patakbuhin ang tinukoy na doclet sa halip na ang karaniwang HtmlDoclet.

pangalan ng klase dapat ang ganap na kwalipikadong pangalan ng isang klase na may pampublikong default
constructor at naglalaman ng isang pamamaraan na may sumusunod na lagda:

import com.sun.javadoc.RootDoc;
pampublikong static na boolean start(RootDoc ​​rootDoc)

Ang mga klase ng Doclet ay ilo-load mula sa classpath na tinukoy gamit -docletpath, Mula
ang classpath na tinukoy gamit -classpath at mula sa default na classpath.

Ang simula dapat iproseso ng pamamaraan ang impormasyong nakalantad ng Doclet API sa pamamagitan ng rootDoc
at bumalik totoo sa tagumpay, hindi totoo sa kabiguan.

Kung gumagamit ka ng third-party na doclet, sumangguni sa dokumentasyon nito para sa karagdagang
mga tagubilin. Tandaan na ang suporta para sa mga third-party na doclets ay eksperimental. Pakiusap
iulat ang anumang mga problemang nararanasan mo, o magbigay ng feedback kapag matagumpay na tumatakbo
mga third-party na applet.

Ang pagpipiliang ito ay maaaring tukuyin ng maraming beses, kung saan ang lahat ng mga doclets ay naisakatuparan
na may parehong puno ng impormasyon na nakalantad sa pamamagitan ng Doclet API para sa bawat Doclet run.

Pagdaragdag Impormasyon sa ang Pagbubuhos

-pamagat ng bintana teksto
paggamit teksto bilang prefix ng pamagat ng browser window.

Kapag tinukoy, ang pamagat ng browser window para sa bawat pahina ay lagyan ng prefix teksto
sa halip na ang default na string Binuo API dokumentasyon.

teksto dapat na plain text (hindi ito dapat maglaman ng mga HTML tag).

-doctitle teksto
Itakda ang teksto ng header ng page ng pangkalahatang-ideya sa teksto.

teksto dapat ay isang maikling plain text string.

Kapag bumubuo ng dokumentasyon para sa isang pakete, ang pagtukoy sa pagpipiliang ito ay pinipilit
henerasyon ng pahina ng pangkalahatang-ideya.

-header htmltext
Idagdag htmltext sa kanang itaas na sulok ng bawat nabuong pahina. htmltext ay karaniwang
itinakda sa pangalan ng proyektong dinodokumento.

-footer htmltext
Idagdag htmltext sa kanang ibabang sulok ng bawat nabuong pahina. htmltext ay madalas
itinakda sa parehong halaga tulad ng para sa -header.

-baba htmltext
Idagdag htmltext hanggang sa pinakailalim ng bawat nabuong pahina, na sumasaklaw sa buong lapad ng
ang pahina. Kapag tinukoy, htmltext karaniwang binubuo ng isang abiso sa copyright at/o
mga link sa iba pang mga pahina ng proyekto.

-addstylesheet file
Palakihin ang default na CSS style sheet gamit ang user-specified stylesheet file.

Ang ibinigay na stylesheet ay nilo-load lang ng bawat HTML page bilang karagdagan sa default
mga, bilang ang huling stylesheet.

Tandaan na ang CSS cascading rules ay nalalapat. Iyon ay, ang iyong mga katangian ng estilo ay magiging lamang
itinalaga kung mayroon silang mas mataas na order ng cascading kaysa gjdocdefault na istilo ni. Isang simple
paraan upang matiyak na ito ang kaso ay ang pagdeklara ng iyong mga override ! mahalaga.

Tingnan mohttp://www.w3.org/TR/REC-CSS2/cascade.html#cascading-order>.

-pangkat heading pkgwildcard:pkgwildcard: ...
Ayusin ang mga ibinigay na pakete sa isang hiwalay na pangkat sa pahina ng pangkalahatang-ideya.

Ang unang argumento ay dapat na isang maikling plain text na ginagamit bilang pamagat ng
pangkat ng pakete. Ang pangalawang argumento ay dapat na isang colon-separated list ng package
mga wildcard. Ang pangkat ay bubuo ng lahat ng mga pakete sa hanay ng dokumentasyon na ang pangalan
tumutugma sa alinman sa mga ibinigay na wildcard.

Mayroon lamang isang wildcard na character, *, na tumutugma sa parehong mga titik sa pangalan ng package
sangkap at ang . paghihiwalay ng mga bahagi ng pangalan ng package. Halimbawa, j*regex gusto
pakete ng tugma java.util.regex. Ang isang mas kapaki-pakinabang na halimbawa ay javax.swing* upang tumugma sa
javax.swing at lahat ng mga sub-package nito.

Ang pagpipiliang ito ay maaaring ibigay nang maraming beses.

FIXME: Impormasyon tungkol sa group nesting dito.

gjdoc -group "Mga Pangunahing Klase" 'java*' \
-group "Swing" 'javax.swing*' \
-group "Mga XML API" 'javax.xml*' \
-group "Iba pang Mga Extension" javax* \
...

-pangkalahatang-ideya file
Idagdag ang XHTML body fragment mula sa file sa pahina ng pangkalahatang-ideya.

file dapat maglaman ng XHTML fragment na may HTML katawan tag bilang root node.

Maaaring gamitin ang opsyong ito upang magbigay ng paglalarawan ng set ng dokumentasyon sa kabuuan.

Kapag tinukoy, ang unang pangungusap ng fragment ay ilalagay sa itaas ng mga talahanayan
listahan ng mga nakadokumentong pakete, kasama ang isang link sa buong kopya ng fragment
na inilalagay sa ibaba ng mga talahanayan.

Kapag bumubuo ng dokumentasyon para sa isang pakete, ang pagtukoy sa pagpipiliang ito ay pinipilit
henerasyon ng pahina ng pangkalahatang-ideya.

-stylesheetfile file
Gamitin ang CSS stylesheet sa file sa halip na ang default na CSS stylesheet.

Kung gusto mo lang i-override ang mga bahagi ng mga default na stylesheet, gamitin -addstylesheet
sa halip.

-pamagat teksto
Hindi na ginagamit. paggamit -doctitle teksto sa halip.

-helpfile file
Kasalukuyang hindi pinapansin ang opsyong ito.

Kapag ipinatupad, gagamitin nito ang XHTML fragment sa file para sa mga nilalaman ng pahina ng tulong
sa halip na ang default na text ng tulong.

Pagkontrol ang Output.

-d direktoryo
Ilagay ang lahat ng output file sa direktoryo (at mga sub-direktoryo). direktoryo ay malilikha
kung wala ito, kasama ang lahat ng hindi umiiral na direktoryo ng magulang at lahat ng kinakailangan
mga sub-direktoryo.

Kung hindi tinukoy, ang output ay ilalagay sa kasalukuyang direktoryo.

-lokal pangalan
Gumamit ng lokal pangalan sa halip na ang default na lokal para sa lahat ng layunin.

pangalan dapat ay isang locale specifier sa form ll_CC[_VAR] saan ll ay isang maliit na titik na dalawang-
letter ISO-639 language code, CC ay isang opsyonal na uppercase na may dalawang titik na ISO-3166 na bansa
code, at Var ay isang opsyonal na variant code. Halimbawa, en tumutukoy sa Ingles, fil
tumutukoy sa US English, at en_US_WIN tumutukoy sa isang lihis na variant ng US English
lokal na lugar

Tandaan na ang mga semantika ng opsyong ito ay eksaktong tumutugma sa mga constructor
ng klase java.util.Locale.

Ang opsyong ito ay kasalukuyang tumutukoy lamang kung aling Collator ang ginagamit para sa pag-uuri ng output
mga elemento. Nangangahulugan ito na magkakaroon lamang ng epekto ang lokal kapag gumagamit ka ng hindi-
ASCII character sa mga identifier.

-charset charset
Hindi na ginagamit. I-override ang tinukoy na pag-encode sa mga output na XHTML file gamit ang ibinigay
by charset.

Kung hindi ibinigay ang opsyong ito, pipiliin ang detalye ng pag-encode sa output na XHTML
tumugma sa encoding na ginamit sa pagsulat ng file (ang pag-encode na ibinigay kasama ng -docencoding,
o ang default na encoding ng iyong platform).

Ang semantika para sa charset ay tinukoy dito:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. Para sa lahat ng praktikal na layunin,
pareho sila sa iba pang mga opsyon na tumatanggap ng mga parameter ng charset.

Narito ang opsyong ito para sa pagiging tugma sa javadoc at dapat iwasan.

-docencoding charset
Gamitin ang ibinigay na charset encoding kapag nagsusulat ng mga output file sa halip na sa iyong platform
default na pag-encode.

Mga halimbawa para sa charset ay US-ASCII, ISO-8859-1 or UTF-8.

Ang mga semantika ng pagpipiliang ito ay eksaktong tumutugma sa mga tagabuo ng klase
java.util.Locale.

-validhtml
Sapilitang pagbuo ng wastong XHTML code. Sinisira nito ang pagiging tugma sa tradisyonal
Javadoc tool sa ilang lawak.

Kung tinukoy ang opsyong ito, magugulo ang mga pangalan ng anchor upang maging wasto ang mga ito
ayon sa detalye ng XHTML 1.1. Gayunpaman, nabuo ang isang set ng dokumentasyon gamit ang
ang opsyong ito ay hindi maiugnay sa wastong paggamit ng tradisyonal na tool na Javadoc. Maaari itong
mai-link sa maayos gamit ang Gjdoc, bagaman.

Kung wala ang opsyong ito, ang mga pangalan ng anchor para sa mga miyembro ng executable na klase ay gumagamit ng tradisyonal
format, halimbawa: "foo(String,int[])". Ito ay katugma sa tradisyonal
Javadoc tool, ngunit ayon sa parehong HTML 4.0 at XHTML 1.0 at 1.1 na mga detalye,
kasama sa format na ito ang mga ilegal na character. Panaklong, square bracket, at kuwit
ay hindi pinapayagan sa mga pangalan ng anchor.

-baseurl url
Mag-hardwire ng URL ng page na nauugnay sa url sa bawat nabuong pahina.

Kung ikaw ay bumubuo ng dokumentasyon na eksklusibong magagamit sa isang tiyak
URL, dapat mong gamitin ang opsyong ito upang tukuyin ang URL na ito.

Makakatulong ito na maiwasan ang ilang partikular na pag-atake sa pag-redirect na ginagamit ng mga spammer, at maaari itong makatulong
para sa ilang partikular na web client.

Verbosity Options

-tahimik
Pigilan ang lahat ng output maliban sa mga babala at mensahe ng error.

-salita
Maging napaka-verbose tungkol sa kung ano gjdoc ay ginagawa.

Kasalukuyang hindi pinapansin ang opsyong ito.

Totoo Makina Options

kay Sun javadoc tool na tila batay sa Javanese at dahil dito ay tila gumagana sa VM
antas. gjdoc, sa kabaligtaran, ay isang purong Java application.

Samakatuwid, gjdoc maaari lamang pekein, o gayahin, ang mga sumusunod na opsyon sa antas ng VM.

-classpath pathlist
Itakda ang Virtual Machine classpath sa pathlist.

Sa karamihan ng mga kaso dapat mong gamitin -docletpath or -tagletpath sa halip na ang opsyong ito.

pathlist ay dapat isa o higit pang mga path sa isang direktoryo o jar file, na pinaghihiwalay ng iyong
separator ng landas ng platform (karaniwan : or ;).

Kung hindi naharang ang opsyong ito sa antas ng wrapper, gjdoc kasalukuyang peke ito ng
pagtatawag System.setProperty("java.class.path", pathlist); at naglalabas ng babala.

-bootclasspath pathlist
Itakda ang Virtual Machine bootclasspath sa pathlist.

Kung hindi naharang ang opsyong ito sa antas ng wrapper, gjdoc naglalabas ng babala.

-Jvmopt
Magpasa ng arbitrary na parameter sa Virtual Machine gjdoc ay tumatakbo sa.

Kung hindi naharang ang opsyong ito sa antas ng wrapper, gjdoc sinusubukang tularan ang
opsyon at naglalabas ng babala.

Sa kasalukuyan, tanging ang VM na opsyon -D para sa pagtatakda ng mga katangian ng system ay ginagaya.

Gamitin ang gjdoc-4.8 online gamit ang mga serbisyo ng onworks.net