gjdoc-4.8 - ອອນລາຍໃນຄລາວ

ໂຄງການ:

NAME

cp-tools - ຄູ່ມື GNU Classpath Tools

ສະຫຼຸບສັງລວມ

gjdoc [- ແຫຼ່ງ​ຂໍ້​ມູນ ເສັ້ນທາງ]
[-ທັງຫມົດ] [- ຊຸດຍ່ອຍ pkg:pkg:...] [- ຍົກ​ເວັ້ນ​ pkglist]
[- ການ​ເຂົ້າ​ລະ​ຫັດ​ ສາຍໄຟ] [- ທ້ອງ​ຖິ່ນ​ ຊື່] [- ແຫຼ່ງ ປ່ອຍ]
[- ສາທາລະນະ] [- ປ້ອງ​ກັນ​] [- ຊຸດ] [-ສ່ວນຕົວ]
[- ຫົວ​ຂໍ້​ ຂໍ້ຄວາມ] [- ຫົວ ຂໍ້ຄວາມ] [- ສ່ວນທ້າຍ ຂໍ້ຄວາມ] [- ລຸ່ມ ຂໍ້ຄວາມ]
[-ການເຊື່ອມຕໍ່ url] [-linkoffline url ເສັ້ນທາງ] [-noqualifier pkg:pkg:...]
[-tagletpath ເສັ້ນທາງ] [-taglet ຊື່ຫ້ອງຮຽນ] [-ແທັກ tagspec]
[- ໃຊ້] [-linksource] [-splitindex] [-noindex] [- ບັນທຶກ]
[-ການປ່ຽນແປງ] [- ຜູ້ຂຽນ] [- ນາມ] [-addstylesheet ເອກະສານ]
[-d ເປົ້າໝາຍ]
[ການຫຸ້ມຫໍ່... ] [ໄຟລ໌ແຫຼ່ງ...] [@cmdfile]

gjdoc [- ແຫຼ່ງ​ຂໍ້​ມູນ ເສັ້ນທາງ]
[-ທັງຫມົດ] [- ຊຸດຍ່ອຍ pkg:pkg:...] [- ຍົກ​ເວັ້ນ​ pkglist]
[- ການ​ເຂົ້າ​ລະ​ຫັດ​ ສາຍໄຟ] [- ທ້ອງ​ຖິ່ນ​ ຊື່] [- ແຫຼ່ງ ປ່ອຍ]
[- ສາທາລະນະ] [- ປ້ອງ​ກັນ​] [- ຊຸດ] [-ສ່ວນຕົວ]
[-docletpath ເສັ້ນທາງ] [- ປະລິນຍາເອກ ຊື່ຫ້ອງຮຽນ]
[ການຫຸ້ມຫໍ່... ] [ໄຟລ໌ແຫຼ່ງ...] [@cmdfile]
[ຕົວເລືອກເອກະສານ]

gjdoc - ຊ່ວຍ

gjdoc - ການປ່ຽນແປງ

ພຽງແຕ່ທາງເລືອກທີ່ເປັນປະໂຫຍດທີ່ສຸດແມ່ນໄດ້ລະບຸໄວ້ຢູ່ທີ່ນີ້; ເບິ່ງຂ້າງລຸ່ມນີ້ສໍາລັບສ່ວນທີ່ເຫຼືອ.

ລາຍລະອຽດ

Gjdoc ສາມາດຖືກນໍາໃຊ້ໃນສອງວິທີ: ເປັນເຄື່ອງມືເອກະສານຢືນຢູ່ຄົນດຽວ, ຫຼືເປັນຕົວຂັບສໍາລັບ a
Doclet ທີ່ລະບຸໂດຍຜູ້ໃຊ້.

ໃນໂໝດເລີ່ມຕົ້ນ, Gjdoc ຈະໃຊ້ Standard Doclet HtmlDoclet ເພື່ອສ້າງຊຸດຂອງ
ໜ້າ HTML. ການ​ນໍາ​ໃຊ້ canonical ແມ່ນ​:

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

ທີ່ນີ້, src/java/ ແມ່ນຮາກຂອງການຈັດລໍາດັບຊັ້ນລະຫັດແຫຼ່ງຂອງເຈົ້າ, -ທັງຫມົດ ຫມາຍຄວາມວ່າທັງຫມົດທີ່ຖືກຕ້ອງ
ໄຟລ໌ Java ທີ່ພົບເຫັນພາຍໃຕ້ໄດເລກະທໍລີຮາກນີ້ຄວນໄດ້ຮັບການປຸງແຕ່ງ, ແລະ api-docs/ ເປັນ
ໄດເລກະທໍລີທີ່ເອກະສານທີ່ສ້າງຂຶ້ນຄວນຈະຖືກວາງໄວ້.

ເພື່ອຮຽນຮູ້ເພີ່ມເຕີມກ່ຽວກັບການແລ່ນ Doclets ນອກເຫນືອຈາກ Standard Doclet, ເບິ່ງຄູ່ມື.

OPTIONS

ທາງເລືອກ Summary by ປະເພດ

ນີ້ແມ່ນບົດສະຫຼຸບຂອງທາງເລືອກທັງຫມົດຂອງ Gjdoc ແລະ Standard Doclet, ຈັດກຸ່ມໂດຍ
ປະເພດ. ຄໍາອະທິບາຍຢູ່ໃນພາກຕໍ່ໄປນີ້.

ແຫຼ່ງຂໍ້ມູນ ທີ່ກໍານົດໄວ້ ທາງເລືອກໃນການ
- ແຫຼ່ງ​ຂໍ້​ມູນ ເສັ້ນທາງ - ຊຸດຍ່ອຍ pkglist - ຍົກ​ເວັ້ນ​ pkglist

ແຫຼ່ງຂໍ້ມູນ ຮູບແບບ ທາງເລືອກໃນການ
- ແຫຼ່ງ ປ່ອຍ - ການ​ເຂົ້າ​ລະ​ຫັດ​ ການເຂົ້າລະຫັດ - ເບກເກີ

ການເຊື່ອມໂຍງກັນ ທາງເລືອກໃນການ
-ການເຊື່ອມຕໍ່ url -linkoffline url ເອກະສານ -noqualifier pkg:pkg:...

ການຜະລິດ ທາງເລືອກໃນການ
- ຜູ້ຂຽນ - ຂໍ້​ຄວາມ​ໃບ​ອະ​ນຸ​ຍາດ​ - ໃຊ້ -ການປ່ຽນແປງ -splitindex -noindex
-nodeprecated -nodeprecatedlist -nohelp -nonavbar
- ນາມ - ບັນທຶກ - ສາທາລະນະ - ປ້ອງ​ກັນ​ - ຊຸດ -ສ່ວນຕົວ
-docfilelessubdir -excludedocfilessubdir ນາມສະກຸນ
-linksource

ຜົນຜະລິດ ທາງເລືອກໃນການ
-d - ທ້ອງ​ຖິ່ນ​ ຊື່ - ຕົວ​ອັກ​ສອນ​ ສາຍໄຟ -docencoding ສາຍໄຟ
-validhtml -baseurl url

ອອກແບບ ທາງເລືອກໃນການ
-windowtitle ຂໍ້ຄວາມ - ຫົວ​ຂໍ້​ ຂໍ້ຄວາມ -ຫົວຂໍ້ ຂໍ້ຄວາມ
- ຫົວ ຂໍ້ຄວາມ - ສ່ວນທ້າຍ ຂໍ້ຄວາມ - ລຸ່ມ ຂໍ້ຄວາມ
-helpfile ເອກະສານ -stylesheetfile ເອກະສານ -addstylesheet ເອກະສານ
- ກຸ່ມ ຫົວຂໍ້ກຸ່ມ pkgpattern:pkgpattern:...

Taglet ທາງເລືອກໃນການ
-tagletpath -taglet ຊື່ຫ້ອງຮຽນ -ແທັກ tagspec

Doclet ທາງເລືອກໃນການ
-docletpath - ປະລິນຍາເອກ ຊື່ຫ້ອງຮຽນ

ວາຈາ ທາງເລືອກໃນການ
- ງຽບ - ກະດູກ

virtual ເຄື່ອງ ທາງເລືອກໃນການ
- classpath -bootclasspath -J vmopt

ການຄັດເລືອກ ທີ່ ແຫຼ່ງຂໍ້ມູນ ໄຟ to ຂະບວນການ

-s ເສັ້ນທາງ
- ແຫຼ່ງ​ຂໍ້​ມູນ ເສັ້ນທາງ
ຊອກຫາໄຟລ໌ແຫຼ່ງໃນໄດເລກະທໍລີທີ່ລະບຸຫຼືໄດເລກະທໍລີ.

ເສັ້ນທາງ ຄວນຈະເປັນໜຶ່ງ ຫຼືຫຼາຍກວ່າໜຶ່ງເສັ້ນທາງໄດເລກະທໍລີທີ່ແຍກອອກໂດຍເສັ້ນທາງຂອງເວທີຂອງທ່ານ
ຕົວແຍກ (ປົກກະຕິແລ້ວ : or ;).

ຖ້າຕົວເລືອກນີ້ບໍ່ໄດ້ຖືກມອບໃຫ້, gjdoc ຈະຊອກຫາໄຟລ໌ຕົ້ນສະບັບໃນປະຈຸບັນ
ລະບົບ.

ໄດເລກະທໍລີທີ່ລະບຸຄວນຈະເປັນໄດເລກະທໍລີຮາກໃນຂໍ້ກໍານົດຂອງຊຸດ Java
ລະບົບ. ຕົວຢ່າງ: ຖ້າທ່ານຕ້ອງການສ້າງເອກະສານສໍາລັບຫ້ອງຮຽນໃນຊຸດ
foo.bar, ທ່ານຕ້ອງລະບຸໄດເລກະທໍລີທີ່ມີລະດັບສູງສຸດ ຟູ ບັນຊີຍ່ອຍ,
ບໍ່ແມ່ນໄດເລກະທໍລີ foo/bar/ ເຊິ່ງໄຟລ໌ແຫຼ່ງ Java ຢູ່.

ນາມແຝງ -s ແມ່ນສະເພາະກັບ gjdoc ແລະບໍ່ເຂົ້າກັນໄດ້ກັບ Sun javadoc.

-ທັງຫມົດ
[ການທົດລອງ] ປະມວນຜົນໄຟລ໌ແຫຼ່ງ Java ທີ່ຖືກຕ້ອງທັງໝົດທີ່ພົບເຫັນຢູ່ໃນໄດເລກະທໍລີທີ່ລະບຸໄວ້ໃນ
ເສັ້ນທາງແຫຼ່ງແລະໄດເລກະທໍລີຍ່ອຍຂອງພວກເຂົາ.

ນີ້ແມ່ນທາງເລືອກທີ່ສະເພາະກັບ gjdoc ແລະບໍ່ເຂົ້າກັນໄດ້ກັບ Sun javadoc.

- ຊຸດຍ່ອຍ pkg:pkg:...
ປະມວນຜົນຫ້ອງຮຽນໃນແພັກເກັດ Java ແລະຊຸດຍ່ອຍທັງໝົດ, recursively.
ກະລຸນາຮັບຊາບວ່າຊື່ແພັກເກັດຫຼາຍອັນຈະຕ້ອງຖືກແຍກອອກດ້ວຍຈໍ້າສອງເມັດແທນທີ່ຈະເປັນຊ່ອງຫວ່າງ.

- ຍົກ​ເວັ້ນ​ pkg:pkg:...
ຢ່າປະມວນຜົນຫ້ອງຮຽນໃນແພັກເກັດ Java ແລະທຸກແພັກເກັດຍ່ອຍ, recursively.
ທາງເລືອກນີ້ສາມາດຖືກນໍາໃຊ້ຮ່ວມກັບ -ທັງຫມົດ or - ຊຸດຍ່ອຍ ເພື່ອຍົກເວັ້ນ
ການຫຸ້ມຫໍ່ສ່ວນບຸກຄົນຫຼືຊຸດຕົ້ນໄມ້ຍ່ອຍຈາກຜົນຜະລິດ.

ການຫຸ້ມຫໍ່...
ປະມວນຜົນຫ້ອງຮຽນທັງໝົດໃນແພັກເກັດ Java ທີ່ໃຫ້ມາ.

ໄຟລ໌ແຫຼ່ງ...
ປະມວນຜົນຫ້ອງຮຽນໃນໄຟລ໌ແຫຼ່ງ Java ທີ່ໃຫ້.

ການລະບຸ ໄດ້ ຮູບແບບ of ການປ້ອນຂໍ້ມູນ ໄຟ

- ແຫຼ່ງ ປ່ອຍ
ສົມມຸດວ່າໄຟລ໌ຕົ້ນສະບັບຖືກເປົ້າຫມາຍຢູ່ໃນການປ່ອຍຂອງແພລະຕະຟອມ Java.

ປ່ອຍ ຄວນເປັນເລກເວີຊັ່ນຂອງເວທີ Java ໃນຮູບແບບ
ສໍາລັບຕົວຢ່າງ, MAJOR.MINOR 1.4.

ທາງເລືອກນີ້ປະຈຸບັນຖືກລະເລີຍຍົກເວັ້ນວ່າມີຂໍ້ຜິດພາດເກີດຂຶ້ນຖ້າມີຈໍານວນການປ່ອຍຕົວ
ອື່ນກ່ວາ 1.2, 1.3 or 1.4 ຖືກກໍານົດ.

- ການ​ເຂົ້າ​ລະ​ຫັດ​ ສາຍໄຟ
ສົມມຸດວ່າໄຟລ໌ຕົ້ນສະບັບຖືກເຂົ້າລະຫັດໂດຍໃຊ້ ສາຍໄຟ.

ຕົວຢ່າງ ສຳ ລັບ ສາຍໄຟ ມີ US-ASCII, ISO-8859-1 or UTF-8.

ຄວາມຫມາຍຂອງ ສາຍໄຟ ແມ່ນຄ້າຍຄືກັນກັບຂອງ
java.nio.charset.Charset.forName(String).

- ເບກເກີ
ໃຊ້ java.text.BreakIterator ຂອງທ້ອງຖິ່ນແທນປະໂຫຍກທຳອິດພາຍໃນ
ເຄື່ອງກວດຈັບ.

ໂດຍຕົວຢ່າງ, gjdoc ໃຊ້ສູດການຄິດໄລ່ພາຍໃນເພື່ອກໍານົດບ່ອນທີ່ປະໂຫຍກສິ້ນສຸດ. ເມື່ອ​ໃດ​
ທາງ​ເລືອກ​ນີ້​ແມ່ນ​ໄດ້​ຮັບ​, ມັນ​ແທນ​ທີ່​ຈະ​ນໍາ​ໃຊ້​ java.text.BreakIterator ຕົວຢ່າງສໍາລັບ
ສະ​ຖານ​ທີ່​ໃຫ້​ກັບ​ - ທ້ອງ​ຖິ່ນ​ (ຫຼືສະຖານທີ່ເລີ່ມຕົ້ນ).

ຕົວເລືອກນີ້ຄວນຈະຖືກລະບຸໃນເວລາສະຫມັກ gjdoc ກັບລະຫັດແຫຼ່ງທີ່ສະແດງຄວາມຄິດເຫັນໃນທີ່ບໍ່ແມ່ນ
ພາສາລາຕິນທີ່ເຄື່ອງກວດຈັບປະໂຫຍກທຳອິດເລີ່ມຕົ້ນບໍ່ເຮັດວຽກ. ສໍາລັບທັງຫມົດ
ກໍລະນີອື່ນໆ, ຄ່າເລີ່ມຕົ້ນ (ບໍ່ໃຊ້ BreakIterator) ຜະລິດຜົນໄດ້ຮັບທີ່ດີກວ່າຢູ່ທີ່
ເວລາຂອງການຂຽນນີ້.

ການເຊື່ອມໂຍງກັນ ກັບ ອື່ນໆ ເອ​ກະ​ສານ ຊຸດ

-ການເຊື່ອມຕໍ່ url
ສ້າງ hyperlinks ກັບຊຸດເອກະສານອື່ນ.

ໂດຍຕົວຢ່າງ, gjdoc ພຽງແຕ່ຈະສ້າງ hyperlinks ກັບຫ້ອງຮຽນໃນຊຸດແຫຼ່ງ. ໃຊ້ນີ້
ທາງ​ເລືອກ​ໃນ​ການ​ເພີ່ມ​ເຕີມ​ສ້າງ hyperlinks ກັບ​ຫ້ອງ​ຮຽນ​ກວມ​ເອົາ​ໂດຍ​ລະ​ບຸ​ໄວ້​
ຊຸດເອກະສານ.

url ຄວນເປັນ URL ຮາກຂອງຊຸດເອກະສານອື່ນໆ. ຕົວຢ່າງ, ເພື່ອເພີ່ມ
hyperlinks ກັບ GNU Classpath, ລະບຸດັ່ງຕໍ່ໄປນີ້:

-ການເຊື່ອມຕໍ່ http://developer.classpath.org/doc/

ໄດ້ -ການເຊື່ອມຕໍ່ ທາງເລືອກສາມາດຖືກລະບຸຫຼາຍຄັ້ງ.

ໃຫ້ສັງເກດວ່າການລະບຸ -ການເຊື່ອມຕໍ່ ທາງເລືອກຈະເຮັດໃຫ້ການເຂົ້າເຖິງ HTTP ທຸກໆຄັ້ງທີ່ gjdoc ຢູ່
ຮຽກຮ້ອງ. ທ່ານສາມາດນໍາໃຊ້ -linkoffline ແທນທີ່ຈະເພື່ອຫຼີກເວັ້ນການເຂົ້າເຖິງນີ້.

-linkoffline url ເອກະສານ
ສ້າງ hyperlinks ກັບຊຸດເອກະສານອື່ນທີ່ມີຢູ່ໃນໄຟລ໌ທ້ອງຖິ່ນ
ລະບົບ.

ຕົວເລືອກນີ້ເຮັດວຽກຄືກັນ -ການເຊື່ອມຕໍ່, ຍົກເວັ້ນວ່າມັນເຂົ້າເຖິງລະບົບໄຟລ໌ທ້ອງຖິ່ນ
ແທນທີ່ຈະເປັນເຄືອຂ່າຍສໍາລັບການກໍານົດວ່າຫ້ອງຮຽນໃດຖືກຄຸ້ມຄອງໂດຍການເຊື່ອມຕໍ່
ຊຸດເອກະສານ.

ເມື່ອນໍາໃຊ້ -linkoffline ຊຸດເອກະສານຫ່າງໄກສອກຫຼີກບໍ່ໄດ້ເຂົ້າເຖິງທັງຫມົດ, ເຊິ່ງສາມາດເຮັດໄດ້
ເລັ່ງເວລາການຜະລິດຢ່າງຫຼວງຫຼາຍຂຶ້ນກັບການເຊື່ອມຕໍ່ເຄືອຂ່າຍຂອງທ່ານ. ໄດ້
hyperlinks ທີ່ສ້າງຂື້ນກັບຊຸດເອກະສານຢ່າງໃດກໍ່ຕາມຫມາຍເຖິງຊຸດຫ່າງໄກສອກຫຼີກ, ບໍ່ແມ່ນ
ທ້ອງຖິ່ນ, ດັ່ງນັ້ນທ່ານສາມາດແຈກຢາຍເອກະສານໂດຍບໍ່ມີການເພີ່ມເຕີມ
ການເພິ່ງພາອາໄສ.

ໄດ້ -linkoffline ທາງເລືອກສາມາດຖືກລະບຸຫຼາຍຄັ້ງ.

-noqualifier pkg:pkg:...
ຫ້າມໃສ່ຊື່ຂອງຊັ້ນຮຽນໃນແພັກເກັດທີ່ໃຫ້ມາດ້ວຍຊື່ແພັກເກັດຂອງເຂົາເຈົ້າ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, ຊື່ຫ້ອງຮຽນຈະສະແດງແບບບໍ່ມີເງື່ອນໄຂພຽງແຕ່ຖ້າຊັ້ນຮຽນເປັນສ່ວນຫນຶ່ງຂອງ
ຊຸດແຫຼ່ງຫຼືຊຸດເອກະສານທີ່ເຊື່ອມໂຍງ, ແລະມີຄຸນສົມບັດທີ່ມີຊື່ຂອງມັນ
ບັນຈຸຊຸດຖ້າມັນບໍ່ແມ່ນ. ທ່ານສາມາດນໍາໃຊ້ທາງເລືອກນີ້ເພື່ອບັງຄັບໃຫ້ຊື່ທີ່ບໍ່ມີເງື່ອນໄຂ
ສໍາລັບຫ້ອງຮຽນເຖິງແມ່ນວ່າພວກເຂົາບໍ່ໄດ້ເປັນສ່ວນຫນຶ່ງຂອງຊຸດເອກະສານ.

ຕົວຢ່າງ, ປົກກະຕິແລ້ວການອ້າງອີງເຖິງຊັ້ນ String ແມ່ນເປັນຕົວແທນທີ່ມີຄຸນສົມບັດຄົບຖ້ວນ
java.lang.String (ເວັ້ນເສຍແຕ່ວ່າທ່ານເຊື່ອມຕໍ່ກັບເອກະສານທີ່ເຫມາະສົມທີ່ກໍານົດໄວ້ໂດຍໃຊ້ -ການເຊື່ອມຕໍ່)
ເນື່ອງຈາກວ່າມັນບໍ່ແມ່ນສ່ວນຫນຶ່ງຂອງຊຸດເອກະສານ. ທ່ານສາມາດກໍານົດ -noqualifier
java.lang ເພື່ອເຮັດໃຫ້ການອ້າງອີງດຽວກັນຄືກັນກັບ string.

ໃຫ້ສັງເກດວ່າສໍາລັບຊື່ຫ້ອງຮຽນທີ່ບໍ່ມີເງື່ອນໄຂທັງຫມົດ, ຄໍາແນະນໍາເຄື່ອງມືແມ່ນສະຫນອງໃຫ້ໃນເວລາທີ່ທ່ານວາງຂອງທ່ານ
ຕົວຊີ້ຫນູໃສ່ມັນຢູ່ໃນເອກະສານ HTML.

-noqualifier ທັງຫມົດ
ຍົກເລີກຄຸນສົມບັດຊຸດຊື່ຈາກຊື່ຊັ້ນຮຽນທັງໝົດ.

ລະບຸຕົວເລືອກນີ້ເພື່ອລະເວັ້ນການກຳນົດຊື່ແພັກເກັດທັງໝົດ,

ການຄັດເລືອກ ທີ່ ຂໍ້ມູນຂ່າວສານ to ສ້າງ

- ສາທາລະນະ
ພຽງແຕ່ລວມເອົາສະມາຊິກສາທາລະນະຂອງຫ້ອງຮຽນສາທາລະນະໃນຜົນໄດ້ຮັບ. ໂດຍຄ່າເລີ່ມຕົ້ນ, ປ້ອງກັນ
ສະມາຊິກໃນຊັ້ນຮຽນແມ່ນລວມເຂົ້າກັນ.

- ປ້ອງ​ກັນ​
ລວມເອົາສະມາຊິກສາທາລະນະຫຼືຖືກປົກປ້ອງຂອງຫ້ອງຮຽນສາທາລະນະຢູ່ໃນຜົນໄດ້ຮັບ. ນີ້​ແມ່ນ
Default

- ຊຸດ
ລວມເອົາສະມາຊິກສາທາລະນະ, ປົກປ້ອງ ແລະຫຸ້ມຫໍ່-ເອກະຊົນຂອງສາທາລະນະ ແລະແພັກເກດ-ເອກະຊົນ
ຫ້ອງຮຽນ.

-ສ່ວນຕົວ
ຮວມທຸກຊັ້ນຮຽນ ແລະສະມາຊິກໃນຊັ້ນຮຽນ ໂດຍບໍ່ຄໍານຶງເຖິງລະດັບການເຂົ້າເຖິງຂອງເຂົາເຈົ້າ.

-splitindex
ສ້າງຫນ້າດັດສະນີຫນຶ່ງຕໍ່ຈົດຫມາຍແທນທີ່ຈະເປັນຫນ້າດັດສະນີ monolithic ດຽວ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, ດັດຊະນີທີ່ສ້າງຂຶ້ນໂດຍ Standard Doclet ມີລາຍການທັງໝົດຢູ່ໃນອັນດຽວ
ຫນ້າ. ນີ້ແມ່ນດີສໍາລັບຊຸດເອກະສານຂະຫນາດນ້ອຍ, ແຕ່ສໍາລັບຊຸດຂະຫນາດໃຫຍ່ທ່ານຄວນ
ລະບຸທາງເລືອກນີ້.

- ນາມ
Ignore @ຕັ້ງແຕ່ tags ໃນຄໍາເຫັນ javadoc.

ໂດຍຄ່າເລີ່ມຕົ້ນ, ຜົນຜະລິດທີ່ສ້າງຂຶ້ນປະກອບດ້ວຍພາກສ່ວນທີ່ລະບຸເວີຊັນຂອງ API ຂອງທ່ານ
ນັບຕັ້ງແຕ່ຊຸດ, ຊັ້ນຮຽນຫຼືສະມາຊິກຊັ້ນຮຽນຢູ່ໃນຄໍາຖາມທີ່ມີຢູ່ໃນເວລາທີ່ແທັກນີ້ແມ່ນ
ພົບ. ລະບຸທາງເລືອກນີ້ເພື່ອລະເວັ້ນຂໍ້ມູນນີ້.

- ບັນທຶກ
ຢ່າສ້າງຫນ້າຕົ້ນໄມ້ໃດໆ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, ຜົນຜະລິດທີ່ສ້າງຂຶ້ນປະກອບມີຕົ້ນໄມ້ມໍລະດົກຕໍ່ຊຸດ, ແລະ - ຖ້າ
ຊຸດເອກະສານປະກອບດ້ວຍຫຼາຍແພັກເກັດ - ຫນ້າທີ່ມີມໍລະດົກອັນເຕັມທີ່
ຕົ້ນໄມ້. ລະບຸຕົວເລືອກນີ້ເພື່ອຍົກເລີກການສ້າງໜ້າເຫຼົ່ານີ້.

-noindex
ບໍ່ໃຫ້ອອກດັດຊະນີຕົວໜັງສື.

ໂດຍຄ່າເລີ່ມຕົ້ນ, gjdoc ສ້າງດັດຊະນີຕົວຫນັງສືຂອງອົງປະກອບໂຄງການທັງຫມົດໃນ
ຊຸດເອກະສານ (ຊຸດ, ຫ້ອງຮຽນ, ຊັ້ນໃນ, ຜູ້ກໍ່ສ້າງ, ວິທີການ, ແລະ
ທົ່ງນາ). ລະບຸທາງເລືອກນີ້ເພື່ອລະເວັ້ນຂໍ້ມູນນີ້.

-nohelp
ຢ່າສ້າງຫນ້າຊ່ວຍເຫຼືອ.

ຕົວເລືອກນີ້ຖືກລະເລີຍໃນຂະນະນີ້ ເນື່ອງຈາກ Standard Doclet ບໍ່ໄດ້ໃຫ້ໜ້າຊ່ວຍເຫຼືອ.

-nodeprecated
ຫ້າມສົ່ງຂໍ້ມູນໃນແຖວກ່ຽວກັບແພັກເກດ, ຊັ້ນຮຽນ ຫຼືສະມາຊິກໃນຊັ້ນຮຽນທີ່ຖືກຍົກເລີກ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, Standard Doclet ເພີ່ມວັກທີ່ເນັ້ນໃສ່ດ້ວຍການປະຕິເສດ
ຂໍ້​ມູນ​ກ່ຽວ​ກັບ​ການ​ອະ​ທິ​ບາຍ​ຂອງ​ແຕ່​ລະ​ອົງ​ປະ​ກອບ​ຂອງ​ໂຄງ​ການ​ທີ່​ຖືກ​ຄັດ​ເລືອກ​. ລະບຸນີ້
ທາງເລືອກທີ່ຈະລະເວັ້ນຂໍ້ມູນນີ້.

-nodeprecatedlist
ຫ້າມອອກໜ້າສະຫຼຸບສໍາລັບອົງປະກອບ API ທີ່ຖືກຍົກເລີກ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, Standard Doclet ຈະສ້າງຫນ້າທີ່ມີລາຍຊື່ອົງປະກອບ API ທີ່ຖືກຍົກເລີກທັງໝົດ
ພ້ອມກັບຄຳອະທິບາຍການຍົກເລີກການສະໜັບສະໜຸນເຊິ່ງໂດຍປົກກະຕິແລ້ວລວມມີເຫດຜົນສຳລັບການຍົກເລີກການສະໜັບສະໜຸນ
ແລະທາງເລືອກທີ່ເປັນໄປໄດ້. ລະບຸທາງເລືອກນີ້ເພື່ອລະເວັ້ນຂໍ້ມູນນີ້.

-nonavbar
ຢ່າສົ່ງແຖບນໍາທາງ, ສ່ວນຫົວ, ແລະສ່ວນທ້າຍອອກ.

ໂດຍຄ່າເລີ່ມຕົ້ນ, ແຕ່ລະຫນ້າຜົນຜະລິດແມ່ນມີແຖບນໍາທາງເທິງ (ເຊິ່ງອາດຈະປະກອບມີ
ສ່ວນຫົວທີ່ລະບຸໂດຍຜູ້ໃຊ້) ແລະແຖບນໍາທາງລຸ່ມ (ເຊິ່ງອາດຈະປະກອບມີຜູ້ໃຊ້-
ສ່ວນທ້າຍທີ່ລະບຸ). ລະບຸທາງເລືອກນີ້ເພື່ອຍົກເລີກການຕົກແຕ່ງນີ້.

-ບໍ່​ມີ​ຄໍາ​ເຫັນ
ຍົກເລີກຂໍ້ຄວາມເອກະສານທັງໝົດຈາກໄຟລ໌ທີ່ສ້າງຂຶ້ນ ແລະສົ່ງອອກພຽງແຕ່ການປະກາດ ແລະ
ຄວາມ​ສໍາ​ພັນ​ອົງ​ປະ​ກອບ​ຂອງ​ໂຄງ​ການ​.

ທາງເລືອກນີ້ແມ່ນຢູ່ທີ່ນີ້ເພື່ອຄວາມເຂົ້າກັນໄດ້ກັບ javadoc. ຖ້າຫາກວ່າທ່ານວາງແຜນກ່ຽວກັບການສະກັດ
ຂໍ້ມູນກ່ຽວກັບໂຄງການຂອງທ່ານໂດຍຜ່ານ gjdoc, ທ່ານຄວນພິຈາລະນາໃຊ້ Doclet ທີ່ແຕກຕ່າງກັນ
ສໍາລັບຈຸດປະສົງຂອງທ່ານແທນທີ່ຈະ, ຕົວຢ່າງ XmlDoclet. ທ່ານຍັງສາມາດໃຊ້ Doclet API ໄດ້
ໂດຍກົງໂດຍການປະຕິບັດ Doclet ໃຫມ່.

-linksource
ສ້າງຫນ້າທີ່ມີ syntax-highlighted source code ສໍາລັບແຕ່ລະຫ້ອງຮຽນ. ໂດຍຄ່າເລີ່ມຕົ້ນ, ນີ້
ໜ້າບໍ່ຖືກສ້າງ.

ລະຫັດແຫຼ່ງສາມາດເຂົ້າເຖິງໄດ້ໂດຍການຄລິກໃສ່ປຸ່ມທີ່ມີປ້າຍຊື່ "ແຫຼ່ງ" ໃນ
ແຖບນໍາທາງ, ຫຼືໂດຍການຄລິກໃສ່ຊື່ຂອງ constructor, ພາກສະຫນາມ, ວິທີການ, ຫຼືພາຍໃນ
ຫ້ອງຮຽນຢູ່ໃນພາກລາຍລະອຽດຂອງຫນ້າເອກະສານຂອງຫ້ອງຮຽນ.

- ໃຊ້
ສ້າງຫນ້າທີ່ມີຂໍ້ມູນອ້າງອີງຂ້າມ. ໂດຍຄ່າເລີ່ມຕົ້ນ, ໜ້ານີ້ບໍ່ແມ່ນ
ສ້າງຂຶ້ນ.

ຂໍ້ມູນການອ້າງອິງຂ້າມສາມາດເຂົ້າເຖິງໄດ້ໂດຍການຄລິກໃສ່ປຸ່ມທີ່ມີປ້າຍຊື່
'ໃຊ້' ໃນແຖບນໍາທາງ.

ໜ້າ 'ໃຊ້' ລາຍຊື່ທຸກຊັ້ນ/ສ່ວນຕິດຕໍ່ໃນເອກະສານທີ່ຕັ້ງໄວ້
ຂະຫຍາຍ / ປະຕິບັດຫ້ອງຮຽນ (ປະເພດ) ໃນຄໍາຖາມ; ທົ່ງນາຂອງປະເພດ; ວິທີການຫຼື
ຜູ້ກໍ່ສ້າງຍອມຮັບຕົວກໍານົດການຂອງປະເພດ; ວິທີການກັບຄືນປະເພດ; ແລະ
ວິທີການຫຼືຜູ້ກໍ່ສ້າງຖິ້ມປະເພດ.

- ຜູ້ຂຽນ
ລວມເອົາຂໍ້ມູນຜູ້ຂຽນໃນຜົນໄດ້ຮັບ.

ເມື່ອລະບຸ, ຂໍ້ມູນຜູ້ຂຽນຕາມທີ່ລະບຸໄວ້ໂດຍໃຊ້ @ຜູ້ຂຽນ tag ໃນ javadoc
ຄໍາເຫັນຖືກລວມເຂົ້າໃນຜົນໄດ້ຮັບ. ໂດຍຄ່າເລີ່ມຕົ້ນ, @ຜູ້ຂຽນ tags ແມ່ນຖືກລະເລີຍ.

-ການປ່ຽນແປງ
ລວມເອົາຂໍ້ມູນສະບັບຢູ່ໃນຜົນຜະລິດ.

ເມື່ອລະບຸ, ຂໍ້ມູນສະບັບທີ່ລະບຸໄວ້ໂດຍໃຊ້ @ເວີຊັ່ນ tag ໃນ javadoc
ຄໍາເຫັນຖືກລວມເຂົ້າໃນຜົນໄດ້ຮັບ. ໂດຍຄ່າເລີ່ມຕົ້ນ, @ເວີຊັ່ນ tags ແມ່ນຖືກລະເລີຍ.

- ຂໍ້​ຄວາມ​ໃບ​ອະ​ນຸ​ຍາດ​
ສົມມຸດວ່າຄໍາຄິດຄໍາເຫັນທໍາອິດໃນແຕ່ລະໄຟລ໌ແຫຼ່ງປະກອບມີຂໍ້ຄວາມໃບອະນຸຍາດ, ແລະເພີ່ມ
ຂໍ້​ມູນ​ອະ​ນຸ​ຍາດ​ໃສ່​ສ່ວນ​ທ້າຍ​ຂອງ​ແຕ່​ລະ​ຫນ້າ​ຊັ້ນ​ຮຽນ​ຜະ​ລິດ​ໄດ້​.

ນີ້ແມ່ນທາງເລືອກທີ່ສະເພາະກັບ gjdoc ແລະບໍ່ເຂົ້າກັນໄດ້ກັບ Sun javadoc.

ທາງເລືອກນີ້ແມ່ນມີຈຸດປະສົງເພື່ອນໍາໃຊ້ກັບໂຄງການແຫຼ່ງຟຣີແລະແຫຼ່ງເປີດບ່ອນທີ່ລະຫັດແຫຼ່ງ
ປົກກະຕິແລ້ວແມ່ນ prefixed ກັບຄໍາຄິດເຫັນໃບອະນຸຍາດ boilerplate, ໃນເວລາທີ່ມີເຫດຜົນທາງດ້ານກົດຫມາຍ
ສໍາລັບການລວມເອົາໃບອະນຸຍາດໃນເອກະສານ.

-docfilelessubdir
Recursively ສໍາ​ເນົາ​ໄຟລ​໌​ທັງ​ຫມົດ​ໃນ​ doc-files sub-directory ຂອງແຕ່ລະ package directory.

ປົກກະຕິແລ້ວ, ພຽງແຕ່ໄຟລ໌ໃນ doc-files ໄດເລກະທໍລີຍ່ອຍຖືກຄັດລອກໂດຍບໍ່ລົງມາ
ຕາມການນັດພົບ.

-excludedocfilessubdir ຊື່:ຊື່: ...
ຢ່າຄັດລອກບາງໄດເລກະທໍລີໂດຍກົງພາຍໃຕ້ຫົວຂໍ້ doc-files ໄດເລກະທໍລີຍ່ອຍເມື່ອ
ຫຼຸດລົງ recursively.

ການໂຕ້ຖຽງກັບທາງເລືອກນີ້ຄວນຈະເປັນບັນຊີລາຍຊື່ທີ່ແຍກອອກໂດຍຈໍ້າສອງເມັດຂອງຊື່ໄດເລກະທໍລີ.

ທາງເລືອກນີ້ພຽງແຕ່ເຮັດໃຫ້ຄວາມຮູ້ສຶກຖ້າຫາກວ່າ -docfilelessubdir ຍັງ​ໄດ້​ລະ​ບຸ​ໄວ້​. ໃນກໍລະນີນີ້, ໃດ
ບັນຊີຍ່ອຍຕັ້ງຢູ່ທາງລຸ່ມ a doc-files ໄດເຣັກທໍຣີຖືກລະເວັ້ນຖ້າມີລາຍຊື່.

Custom ເອ​ກະ​ສານ Tags

-tagletpath ເສັ້ນທາງ
ຄົ້ນຫາ ເສັ້ນທາງ ເມື່ອໂຫລດຫ້ອງຮຽນ Taglet ຕໍ່ໄປທີ່ລະບຸໄວ້ໂດຍໃຊ້ -taglet.

ເສັ້ນທາງ ຄວນຈະເປັນໜຶ່ງ ຫຼືຫຼາຍເສັ້ນທາງໄປຫາໄດເລກະທໍລີ ຫຼືໄຟລ໌ກະປ໋ອງ, ແຍກໂດຍເຈົ້າ
ຕົວແຍກເສັ້ນທາງຂອງເວທີ (ປົກກະຕິແລ້ວ : or ;).

-taglet ຊື່ຫ້ອງຮຽນ
ລົງທະບຽນ Taglet.

ຊື່ຫ້ອງຮຽນ ຄວນເປັນຊື່ທີ່ມີຄຸນວຸດທິຄົບຖ້ວນຂອງການປະຕິບັດຫ້ອງຮຽນ Java
com.sun.tools.doclets.Taglet.

ຫ້ອງຮຽນ Taglet ຈະຖືກໂຫລດຈາກ classpath ທີ່ລະບຸໄວ້ໂດຍໃຊ້ -tagletpath, ຈາກ
classpath ລະບຸໂດຍໃຊ້ - classpath ແລະຈາກ classpath ເລີ່ມຕົ້ນ.

ເບິ່ງເອກະສານຂອງ com.sun.tools.doclets.Taglet ສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ.

ໃຫ້ສັງເກດວ່າສໍາລັບ tags ງ່າຍດາຍ, ຍັງມີ -ແທັກ.

-ແທັກ tagspec
ລົງທະບຽນ Taglet ທົ່ວໄປ.

ຮູບແບບຂອງ tagspec ຕ້ອງເປັນ : :" ".

ຊື່ແທັກ ແມ່ນຊື່ແທັກທີ່ກົງກັນ, ໂດຍບໍ່ມີເຄື່ອງໝາຍ @ ນໍາໜ້າ.

ທົງ ແມ່ນໜຶ່ງ ຫຼືຫຼາຍກວ່າໜຶ່ງຕົວໜັງສືຕໍ່ໄປນີ້, ເຊິ່ງແຕ່ລະຕົວອັກສອນລະບຸ a
ເນື້ອໃນລະຫັດແຫຼ່ງທີ່ແທັກຈະຖືກຮັບຮູ້.

a ສະພາບການທັງໝົດ

c ຜູ້ກໍ່ສ້າງ

f ທົ່ງນາ

m ວິທີການ

o ພາບລວມ

p ການຫຸ້ມຫໍ່

t ປະເພດ (ຊັ້ນຮຽນ, ການໂຕ້ຕອບ, ຂໍ້ຍົກເວັ້ນ, ຄວາມຜິດພາດ)

X ລັກສະນະພິເສດທີ່ປິດການໃຊ້ງານ Taglet ທັງຫມົດຊົ່ວຄາວ.

taghead ແມ່ນສະຕຣິງທີ່ຈະສະແດງຢູ່ໃນສ່ວນຫົວຂອງພາກສ່ວນທີ່ອຸທິດໃຫ້ກັບແທັກໃນ
ຄໍາຖາມ.

ຕົວຢ່າງ, ເພື່ອກໍານົດການຈັບຄູ່ແທັກ @cvsid ທີ່​ຈະ​ໄດ້​ຮັບ​ການ​ຍອມ​ຮັບ​ໃນ​ສະ​ພາບ​ລວມ​,
ແພັກເກັດແລະຫນ້າປະເພດແລະທີ່ຕິດສະຫຼາກກັບສ່ວນຫົວ CVS ID, ເຈົ້າ​ຈະ
ລະບຸ:

-tag cvsid:tpo: "CVS ID"

ໃຫ້ເວົ້າວ່າຄໍາຄິດຄໍາເຫັນຂອງຫ້ອງຮຽນ javadoc ມີ

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

ຫຼັງຈາກນັ້ນ, ຜົນຜະລິດ HTML ຈະມີບາງສິ່ງບາງຢ່າງເຊັ່ນ:

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

ເຮັດວຽກ ອື່ນ ໆ ເອກະສານ

-docletpath ເສັ້ນທາງ
ຄົ້ນຫາ ເສັ້ນທາງ ເມື່ອໂຫລດຊັ້ນຮຽນສໍາລັບ Doclet ທີ່ລະບຸໄວ້ໂດຍໃຊ້ - ປະລິນຍາເອກ.

ເສັ້ນທາງ ຄວນຈະເປັນໜຶ່ງ ຫຼືຫຼາຍເສັ້ນທາງໄປຫາໄດເລກະທໍລີ ຫຼືໄຟລ໌ກະປ໋ອງ, ແຍກໂດຍເຈົ້າ
ຕົວແຍກເສັ້ນທາງຂອງເວທີ (ປົກກະຕິແລ້ວ : or ;).

- ປະລິນຍາເອກ ຊື່ຫ້ອງຮຽນ
ດໍາເນີນການ doclet ທີ່ກໍານົດໄວ້ແທນທີ່ຈະເປັນ HtmlDoclet ມາດຕະຖານ.

ຊື່ຫ້ອງຮຽນ ຄວນເປັນຊື່ທີ່ມີຄຸນສົມບັດຄົບຖ້ວນຂອງຊັ້ນຮຽນທີ່ມີຄ່າເລີ່ມຕົ້ນສາທາລະນະ
constructor ແລະມີວິທີການທີ່ມີລາຍເຊັນຕໍ່ໄປນີ້:

ນໍາເຂົ້າ com.sun.javadoc.RootDoc;
ການເລີ່ມຕົ້ນ boolean ຄົງທີ່ສາທາລະນະ (RootDoc ​​rootDoc)

ຫ້ອງຮຽນ Doclet ຈະຖືກໂຫລດຈາກ classpath ທີ່ລະບຸໄວ້ໂດຍໃຊ້ -docletpath, ຈາກ
classpath ລະບຸໂດຍໃຊ້ - classpath ແລະຈາກ classpath ເລີ່ມຕົ້ນ.

ໄດ້ ການເລີ່ມຕົ້ນ ວິທີການຄວນປະມວນຜົນຂໍ້ມູນທີ່ເປີດເຜີຍໂດຍ Doclet API ຜ່ານ rootDoc
ແລະກັບຄືນ ທີ່ແທ້ຈິງ ກ່ຽວ​ກັບ​ຄວາມ​ສໍາ​ເລັດ​, ທີ່ບໍ່ຖືກຕ້ອງ ກ່ຽວ​ກັບ​ຄວາມ​ລົ້ມ​ເຫຼວ​.

ຖ້າທ່ານກໍາລັງໃຊ້ doclet ພາກສ່ວນທີສາມ, ອ້າງອີງໃສ່ເອກະສານຂອງມັນສໍາລັບການເພີ່ມເຕີມ
ຄໍາແນະນໍາ. ໃຫ້ສັງເກດວ່າການສະຫນັບສະຫນູນ doclets ພາກສ່ວນທີສາມແມ່ນການທົດລອງ. ກະລຸນາ
ລາຍ​ງານ​ບັນ​ຫາ​ໃດ​ຫນຶ່ງ​ທີ່​ທ່ານ​ພົບ​ເຫັນ​, ຫຼື​ໃຫ້​ຄໍາ​ຄຶດ​ຄໍາ​ເຫັນ​ໃນ​ເວ​ລາ​ທີ່​ແລ່ນ​ສົບ​ຜົນ​ສໍາ​ເລັດ​
applets ພາກສ່ວນທີສາມ.

ທາງເລືອກນີ້ສາມາດຖືກກໍານົດຫຼາຍຄັ້ງ, ໃນກໍລະນີນີ້ doclets ທັງຫມົດຖືກປະຕິບັດ
ກັບຕົ້ນໄມ້ຂໍ້ມູນດຽວກັນທີ່ເປີດເຜີຍຜ່ານ Doclet API ສໍາລັບແຕ່ລະ Doclet run.

ເພີ່ມຕື່ມ ຂໍ້ມູນຂ່າວສານ to ໄດ້ ຜົນຜະລິດ

-windowtitle ຂໍ້ຄວາມ
ການນໍາໃຊ້ ຂໍ້ຄວາມ ເປັນຄໍານໍາຫນ້າຫົວຂໍ້ຫນ້າຕ່າງຂອງຕົວທ່ອງເວັບ.

ເມື່ອລະບຸໄວ້, ຫົວຂໍ້ຂອງປ່ອງຢ້ຽມຂອງຕົວທ່ອງເວັບສໍາລັບແຕ່ລະຫນ້າຈະຖືກນໍາຫນ້າດ້ວຍ ຂໍ້ຄວາມ
ແທນທີ່ຈະເປັນ string ເລີ່ມຕົ້ນ ຜະລິດ API ເອ​ກະ​ສານ.

ຂໍ້ຄວາມ ຄວນເປັນຂໍ້ຄວາມທຳມະດາ (ມັນບໍ່ຄວນມີແທັກ HTML).

- ຫົວ​ຂໍ້​ ຂໍ້ຄວາມ
ຕັ້ງຂໍ້ຄວາມສ່ວນຫົວຂອງໜ້າພາບລວມເປັນ ຂໍ້ຄວາມ.

ຂໍ້ຄວາມ ຄວນເປັນສະຕຣິງຂໍ້ຄວາມທຳມະດາສັ້ນ.

ເມື່ອສ້າງເອກະສານສໍາລັບຊຸດດຽວ, ການລະບຸທາງເລືອກນີ້ບັງຄັບ
ການຜະລິດຂອງຫນ້າພາບລວມ.

- ຫົວ html ຂໍ້ຄວາມ
ຕື່ມ html ຂໍ້ຄວາມ ໄປທາງຂວາເທິງຂອງທຸກໆຫນ້າທີ່ຜະລິດ. html ຂໍ້ຄວາມ ແມ່ນປົກກະຕິແລ້ວ
ກໍານົດເປັນຊື່ຂອງໂຄງການທີ່ຖືກບັນທຶກໄວ້.

- ສ່ວນທ້າຍ html ຂໍ້ຄວາມ
ຕື່ມ html ຂໍ້ຄວາມ ໄປມຸມຂວາລຸ່ມຂອງທຸກຫນ້າທີ່ສ້າງ. html ຂໍ້ຄວາມ ແມ່ນເລື້ອຍໆ
ຕັ້ງເປັນຄ່າດຽວກັນກັບສໍາລັບ - ຫົວ.

- ລຸ່ມ html ຂໍ້ຄວາມ
ຕື່ມ html ຂໍ້ຄວາມ ໄປທາງລຸ່ມສຸດຂອງທຸກໆຫນ້າທີ່ຜະລິດ, ກວມເອົາຄວາມກວ້າງທັງຫມົດຂອງ
ຫນ້າ. ເມື່ອລະບຸໄວ້, html ຂໍ້ຄວາມ ປົກກະຕິແລ້ວປະກອບດ້ວຍແຈ້ງການລິຂະສິດ ແລະ/ຫຼື
ເຊື່ອມຕໍ່ກັບຫນ້າໂຄງການອື່ນໆ.

-addstylesheet ເອກະສານ
ຂະຫຍາຍແຜ່ນສະໄຕລ໌ CSS ເລີ່ມຕົ້ນດ້ວຍສະໄຕລ໌ຊີດທີ່ຜູ້ໃຊ້ລະບຸ ເອກະສານ.

ແຜ່ນສະໄຕລ໌ທີ່ໃຫ້ມາແມ່ນຖືກໂຫລດງ່າຍໆໂດຍແຕ່ລະຫນ້າ HTML ນອກເຫນືອຈາກຄ່າເລີ່ມຕົ້ນ
ບໍ່, ເປັນຮູບແບບສຸດທ້າຍ.

ໃຫ້ສັງເກດວ່າກົດລະບຽບ CSS cascading ຖືກນໍາໃຊ້. ນັ້ນແມ່ນ, ຄຸນສົມບັດແບບຂອງເຈົ້າຈະເປັນພຽງແຕ່
ມອບຫມາຍຖ້າພວກເຂົາມີຄໍາສັ່ງ cascading ສູງກວ່າ gjdocຮູບແບບເລີ່ມຕົ້ນຂອງ. ຫນຶ່ງງ່າຍດາຍ
ວິທີການເພື່ອເຮັດໃຫ້ແນ່ໃຈວ່ານີ້ແມ່ນກໍລະນີແມ່ນເພື່ອປະກາດ overrides ຂອງທ່ານ !ສຳຄັນ.

ເບິ່ງhttp://www.w3.org/TR/REC-CSS2/cascade.html#ສັ່ງກັນຂ້າມ>.

- ກຸ່ມ ຫົວ​ຂໍ້ pkgwildcard:pkgwildcard: ...
ຈັດແຈງຊຸດທີ່ໃຫ້ຢູ່ໃນກຸ່ມແຍກຕ່າງຫາກຢູ່ໃນຫນ້າພາບລວມ.

ການໂຕ້ຖຽງທໍາອິດຄວນຈະເປັນຂໍ້ຄວາມທໍາມະດາສັ້ນທີ່ຖືກນໍາໃຊ້ເປັນຫົວຂໍ້ຂອງ
ກຸ່ມຊຸດ. ການໂຕ້ແຍ້ງທີສອງຄວນຈະເປັນລາຍການຊຸດທີ່ແຍກອອກດ້ວຍຈໍ້າສອງເມັດ
ຕົວແທນ. ກຸ່ມຈະປະກອບດ້ວຍຊຸດເອກະສານທັງໝົດໃນຊຸດເອກະສານທີ່ມີຊື່
ກົງກັບຕົວແທນທີ່ໃຫ້ໄວ້.

ມີຕົວອັກສອນແທນຕົວດຽວເທົ່ານັ້ນ, *, ເຊິ່ງກົງກັບຕົວອັກສອນທັງສອງໃນຊື່ແພັກເກັດ
ອົງ​ປະ​ກອບ​ແລະ​ . ແຍກອົງປະກອບຊື່ແພັກເກດ. ຍົກ​ຕົວ​ຢ່າງ, j*regex ຈະ
ຈັບຄູ່ຊຸດ java.util.regex. ຕົວຢ່າງທີ່ເປັນປະໂຫຍດກວ່າຈະເປັນ javax.swing* ກົງກັນ
javax.swing ແລະຊຸດຍ່ອຍທັງໝົດຂອງມັນ.

ທາງເລືອກນີ້ສາມາດຖືກມອບໃຫ້ຫຼາຍຄັ້ງ.

FIXME: ຂໍ້ມູນກ່ຽວກັບການສ້າງກຸ່ມຢູ່ບ່ອນນີ້.

gjdoc -group "Core Classes" 'java*' \
-ກຸ່ມ "Swing" 'javax.swing*' \
-group "XML APIs" 'javax.xml*' \
-group "ສ່ວນຂະຫຍາຍອື່ນໆ" javax* \
...

- ພາບ​ລວມ​ ເອກະສານ
ເພີ່ມຊິ້ນສ່ວນຂອງຮ່າງກາຍ XHTML ຈາກ ເອກະສານ ໄປທີ່ໜ້າພາບລວມ.

ເອກະສານ ຄວນມີຊິ້ນສ່ວນ XHTML ກັບ HTML ຮ່າງກາຍ tag ເປັນ node ຮາກ.

ທາງເລືອກນີ້ສາມາດຖືກນໍາໃຊ້ເພື່ອສະຫນອງລາຍລະອຽດຂອງເອກະສານທີ່ກໍານົດໄວ້ທັງຫມົດ.

ເມື່ອລະບຸໄວ້, ປະໂຫຍກທໍາອິດຂອງຊິ້ນຈະຖືກວາງໄວ້ຂ້າງເທິງຕາຕະລາງ
ລາຍຊື່ຊຸດເອກະສານ, ພ້ອມກັບການເຊື່ອມຕໍ່ກັບສໍາເນົາເຕັມຂອງຊິ້ນ
ເຊິ່ງວາງໄວ້ຂ້າງລຸ່ມນີ້ຕາຕະລາງ.

ເມື່ອສ້າງເອກະສານສໍາລັບຊຸດດຽວ, ການລະບຸທາງເລືອກນີ້ບັງຄັບ
ການຜະລິດຂອງຫນ້າພາບລວມ.

-stylesheetfile ເອກະສານ
ໃຊ້ CSS stylesheet ໃນ ເອກະສານ ແທນທີ່ຈະເປັນ CSS stylesheets ເລີ່ມຕົ້ນ.

ຖ້າເຈົ້າພຽງແຕ່ຕ້ອງການລົບລ້າງສ່ວນຕ່າງໆຂອງສະໄຕລ໌ຊີດເລີ່ມຕົ້ນ, ໃຫ້ໃຊ້ -addstylesheet
ແທນທີ່ຈະເປັນ.

-ຫົວຂໍ້ ຂໍ້ຄວາມ
ເຊົາສະໜັບສະໜູນ. ການນໍາໃຊ້ - ຫົວ​ຂໍ້​ ຂໍ້ຄວາມ ແທນທີ່ຈະເປັນ.

-helpfile ເອກະສານ
ຕອນນີ້ຕົວເລືອກນີ້ຖືກລະເລີຍ.

ເມື່ອປະຕິບັດ, ມັນຈະໃຊ້ຊິ້ນ XHTML ໃນ ເອກະສານ ສໍາລັບເນື້ອໃນຂອງຫນ້າຊ່ວຍເຫຼືອ
ແທນທີ່ຈະເປັນຂໍ້ຄວາມຊ່ວຍເຫຼືອເລີ່ມຕົ້ນ.

ການຄວບຄຸມ ໄດ້ ຜົນໄດ້ຮັບ.

-d ລະບົບ
ວາງໄຟລ໌ຜົນຜະລິດທັງຫມົດເຂົ້າໄປໃນ ລະບົບ (ແລະລາຍການຍ່ອຍ). ລະບົບ ຈະຖືກສ້າງຂື້ນ
ຖ້າມັນບໍ່ມີ, ລວມທັງໄດເລກະທໍລີພໍ່ແມ່ທີ່ບໍ່ມີຢູ່ແລ້ວແລະທັງຫມົດທີ່ຕ້ອງການ
ລາຍຊື່ຍ່ອຍ.

ຖ້າບໍ່ໄດ້ລະບຸ, ຜົນຜະລິດຈະຖືກຈັດໃສ່ໃນໄດເລກະທໍລີປະຈຸບັນ.

- ທ້ອງ​ຖິ່ນ​ ຊື່
ໃຊ້ທ້ອງຖິ່ນ ຊື່ ແທນທີ່ຈະເປັນທ້ອງຖິ່ນເລີ່ມຕົ້ນສໍາລັບຈຸດປະສົງທັງຫມົດ.

ຊື່ ຄວນເປັນຕົວລະບຸທ້ອງຖິ່ນໃນຮູບແບບ ll_CC[_VAR] ບ່ອນທີ່ ll ເປັນຕົວພິມນ້ອຍສອງ-
ຕົວອັກສອນ ISO-639 ລະຫັດພາສາ, CC ເປັນປະເທດທີ່ເປັນຕົວພິມໃຫຍ່ທາງເລືອກ ISO-3166 ສອງໂຕ
ລະຫັດ, ແລະ VAR ເປັນລະຫັດຕົວແປທາງເລືອກ. ຍົກ​ຕົວ​ຢ່າງ, en ກໍາ​ນົດ​ພາ​ສາ​ອັງ​ກິດ​, ໃນສະຫະລັດ
ລະບຸພາສາອັງກິດສະຫະລັດ, ແລະ en_US_WIN ລະບຸຕົວແປທີ່ບິດເບືອນຂອງພາສາອັງກິດສະຫະລັດ
ທ້ອງຖິ່ນ.

ໃຫ້ສັງເກດວ່າ semantics ຂອງຕົວເລືອກນີ້ກົງກັນກັບຜູ້ກໍ່ສ້າງ
ຂອງຫ້ອງຮຽນ java.util.Locale.

ຕົວເລືອກນີ້ໃນປັດຈຸບັນພຽງແຕ່ກໍານົດວ່າ Collator ໃດຖືກໃຊ້ສໍາລັບການຈັດລຽງຜົນຜະລິດ
ອົງປະກອບ. ນີ້ຫມາຍຄວາມວ່າທ້ອງຖິ່ນຈະມີຜົນກະທົບພຽງແຕ່ໃນເວລາທີ່ທ່ານໃຊ້ທີ່ບໍ່ແມ່ນ.
ຕົວອັກສອນ ASCII ໃນຕົວລະບຸ.

- ຕົວ​ອັກ​ສອນ​ ສາຍໄຟ
ເຊົາສະໜັບສະໜູນ. ລົບລ້າງການເຂົ້າລະຫັດທີ່ລະບຸໄວ້ໃນໄຟລ໌ XHTML ທີ່ມີຜົນໄດ້ຮັບ
by ສາຍໄຟ.

ຖ້າຕົວເລືອກນີ້ບໍ່ໄດ້ຖືກມອບໃຫ້, ສະເພາະການເຂົ້າລະຫັດໃນຜົນຜະລິດ XHTML ຈະຖືກເລືອກໃຫ້
ຈັບຄູ່ການເຂົ້າລະຫັດທີ່ໃຊ້ໃນເວລາຂຽນໄຟລ໌ (ການເຂົ້າລະຫັດໃຫ້ກັບ -docencoding,
ຫຼືການເຂົ້າລະຫັດເລີ່ມຕົ້ນຂອງເວທີຂອງທ່ານ).

ຄວາມຫມາຍສໍາລັບ ສາຍໄຟ ໄດ້​ລະ​ບຸ​ໄວ້​ທີ່​ນີ້​:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. ສໍາລັບຈຸດປະສົງປະຕິບັດທັງຫມົດ,
ພວກມັນຄ້າຍຄືກັນກັບທາງເລືອກອື່ນທີ່ຍອມຮັບຕົວກໍານົດການ charset.

ທາງເລືອກນີ້ແມ່ນຢູ່ທີ່ນີ້ເພື່ອຄວາມເຂົ້າກັນໄດ້ກັບ javadoc ແລະຄວນຫລີກລ້ຽງ.

-docencoding ສາຍໄຟ
ໃຊ້ການເຂົ້າລະຫັດຊຸດຕົວໜັງສືທີ່ໃຫ້ມາເມື່ອຂຽນໄຟລ໌ຜົນຜະລິດແທນທີ່ເວທີຂອງເຈົ້າ
ການເຂົ້າລະຫັດເລີ່ມຕົ້ນ.

ຕົວຢ່າງ ສຳ ລັບ ສາຍໄຟ ມີ US-ASCII, ISO-8859-1 or UTF-8.

ຄວາມຫມາຍຂອງທາງເລືອກນີ້ກົງກັນກັບຜູ້ກໍ່ສ້າງຂອງຊັ້ນຮຽນ
java.util.Locale.

-validhtml
ບັງຄັບການສ້າງລະຫັດ XHTML ທີ່ຖືກຕ້ອງ. ນີ້ທໍາລາຍຄວາມເຂົ້າກັນໄດ້ກັບແບບດັ້ງເດີມ
ເຄື່ອງມື Javadoc ໃນບາງຂອບເຂດ.

ຖ້າຕົວເລືອກນີ້ຖືກລະບຸ, ຊື່ສະມໍຈະຖືກຂັດເພື່ອໃຫ້ພວກມັນຖືກຕ້ອງ
ອີງຕາມຂໍ້ມູນສະເພາະຂອງ XHTML 1.1. ຢ່າງໃດກໍຕາມ, ຊຸດເອກະສານທີ່ສ້າງຂຶ້ນດ້ວຍ
ທາງເລືອກນີ້ບໍ່ສາມາດເຊື່ອມໂຍງກັບການນໍາໃຊ້ເຄື່ອງມື Javadoc ແບບດັ້ງເດີມຢ່າງຖືກຕ້ອງ. ມັນ​ສາ​ມາດ
ໄດ້ຮັບການເຊື່ອມຕໍ່ກັບພຽງແຕ່ດີໂດຍໃຊ້ Gjdoc, ເຖິງແມ່ນວ່າ.

ຖ້າບໍ່ມີທາງເລືອກນີ້, ຊື່ສະມໍສໍາລັບສະມາຊິກຫ້ອງຮຽນທີ່ປະຕິບັດໄດ້ໃຊ້ແບບດັ້ງເດີມ
ຮູບແບບ, ຕົວຢ່າງ: "foo(String, int[])". ນີ້ແມ່ນເຫມາະສົມກັບແບບດັ້ງເດີມ
ເຄື່ອງມື Javadoc, ແຕ່ອີງຕາມທັງ HTML 4.0 ແລະ XHTML 1.0 ແລະ 1.1 ສະເພາະ,
ຮູບແບບນີ້ລວມມີຕົວອັກສອນທີ່ຜິດກົດໝາຍ. ວົງເລັບ, ວົງເລັບສີ່ຫຼ່ຽມ, ແລະເຄື່ອງໝາຍຈຸດ
ບໍ່ອະນຸຍາດໃຫ້ໃຊ້ໃນຊື່ສະມໍ.

-baseurl url
Hardwire URL ຂອງຫນ້າທີ່ກ່ຽວຂ້ອງກັບ url ເຂົ້າໄປໃນແຕ່ລະຫນ້າທີ່ສ້າງ.

ຖ້າ​ຫາກ​ວ່າ​ທ່ານ​ກໍາ​ລັງ​ສ້າງ​ເອ​ກະ​ສານ​ທີ່​ສະ​ເພາະ​ແຕ່​ຈະ​ມີ​ຢູ່​ໃນ​ສະ​ເພາະ​ໃດ​ຫນຶ່ງ​
URL, ທ່ານຄວນໃຊ້ຕົວເລືອກນີ້ເພື່ອລະບຸ URL ນີ້.

ນີ້ສາມາດຊ່ວຍຫຼີກເວັ້ນການໂຈມຕີການປ່ຽນເສັ້ນທາງທີ່ແນ່ນອນທີ່ໃຊ້ໂດຍ spammers, ແລະມັນສາມາດເປັນປະໂຫຍດ
ສໍາລັບລູກຄ້າເວັບທີ່ແນ່ນອນ.

ວາຈາ ທາງເລືອກໃນການ

- ງຽບ
ສະກັດກັ້ນຜົນຜະລິດທັງຫມົດຍົກເວັ້ນສໍາລັບຄໍາເຕືອນແລະຂໍ້ຄວາມສະແດງຂໍ້ຜິດພາດ.

- ກະດູກ
ຈະ verbose ຫຼາຍກ່ຽວກັບສິ່ງທີ່ gjdoc ກຳ ລັງເຮັດຢູ່.

ຕອນນີ້ຕົວເລືອກນີ້ຖືກລະເລີຍ.

virtual ເຄື່ອງ ທາງເລືອກໃນການ

ດວງອາທິດ javadoc ເຄື່ອງມືເບິ່ງຄືວ່າອີງໃສ່ ພາສາ Javanese ແລະດັ່ງນັ້ນມັນເບິ່ງຄືວ່າຈະດໍາເນີນການຢູ່ໃນ VM
ລະດັບ. gjdocໃນທາງກົງກັນຂ້າມ, ເປັນຄໍາຮ້ອງສະຫມັກ Java ບໍລິສຸດ.

ເພາະສະນັ້ນ, gjdoc ພຽງແຕ່ສາມາດປອມແປງ, ຫຼືຈໍາລອງ, ທາງເລືອກລະດັບ VM ຕໍ່ໄປນີ້.

- classpath ເສັ້ນທາງ
ຕັ້ງເຄື່ອງ Virtual classpath to ເສັ້ນທາງ.

ໃນກໍລະນີຫຼາຍທີ່ສຸດ, ທ່ານຄວນໃຊ້ -docletpath or -tagletpath ແທນ​ທີ່​ຈະ​ເປັນ​ທາງ​ເລືອກ​ນີ້​.

ເສັ້ນທາງ ຄວນຈະເປັນໜຶ່ງ ຫຼືຫຼາຍເສັ້ນທາງໄປຫາໄດເລກະທໍລີ ຫຼືໄຟລ໌ກະປ໋ອງ, ແຍກໂດຍເຈົ້າ
ຕົວແຍກເສັ້ນທາງຂອງເວທີ (ປົກກະຕິແລ້ວ : or ;).

ຖ້າຕົວເລືອກນີ້ບໍ່ໄດ້ຖືກສະກັດຢູ່ໃນລະດັບ wrapper, gjdoc ໃນປັດຈຸບັນປອມແປງມັນໂດຍ
ໂທຫາ System.setProperty("java.class.path", ເສັ້ນທາງ); ແລະອອກຄໍາເຕືອນ.

-bootclasspath ເສັ້ນທາງ
ຕັ້ງເຄື່ອງ Virtual bootclasspath to ເສັ້ນທາງ.

ຖ້າຕົວເລືອກນີ້ບໍ່ໄດ້ຖືກສະກັດຢູ່ໃນລະດັບ wrapper, gjdoc ອອກ​ຄໍາ​ເຕືອນ​.

-Jvmopt
ຖ່າຍທອດພາຣາມິເຕີທີ່ກຳນົດເອງໄປຫາເຄື່ອງສະເໝືອນ gjdoc ແລ່ນສຸດ.

ຖ້າຕົວເລືອກນີ້ບໍ່ໄດ້ຖືກສະກັດຢູ່ໃນລະດັບ wrapper, gjdoc ພະຍາຍາມເຮັດຕາມແບບຢ່າງ
ທາງ​ເລືອກ​ແລະ​ອອກ​ຄໍາ​ເຕືອນ​.

ໃນປັດຈຸບັນ, ພຽງແຕ່ທາງເລືອກ VM -D ສໍາລັບການຕັ້ງຄ່າຄຸນສົມບັດຂອງລະບົບແມ່ນເຮັດຕາມ.

ໃຊ້ gjdoc-4.8 ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net