gjdoc-4.8 - ออนไลน์ในคลาวด์

โครงการ:

ชื่อ

cp-tools - คู่มือเครื่องมือคลาสพาธของ GNU

เรื่องย่อ

gjdoc [-แหล่งที่มา รายการเส้นทาง]
[-ทั้งหมด] [-แพ็คเกจย่อย พีกก:พีกก:...] [-ไม่รวม pkglist]
[-การเข้ารหัส ชุดอักขระ] [-โลแคล ชื่อ] [ที่มา- ปล่อย]
[- สาธารณะ] [-มีการป้องกัน] [- แพคเกจ] [-เอกชน]
[-doctitle ข้อความ] [-หัวข้อ ข้อความ] [- ส่วนท้าย ข้อความ] [-ด้านล่าง ข้อความ]
[ลิงค์ URL] [-linkออฟไลน์ URL เส้นทาง] [- ไม่มีคุณสมบัติ พีกก:พีกก:...]
[-แท็กเล็ตพาธ รายการเส้นทาง] [-แท็กเล็ต ชื่อคลาส] [- แท็ก แท็กสเปค]
[-ใช้] [-ลิงค์ซอร์ส] [-splitindex] [-ไม่มีดัชนี] [-โนทรี]
[-version] [-ผู้เขียน] [-nosince] [-เพิ่มสไตล์ชีต ไฟล์]
[-d เป้าหมาย]
[แพคเกจ... ] [ไฟล์ต้นฉบับ-cmdfile.php]

gjdoc [-แหล่งที่มา รายการเส้นทาง]
[-ทั้งหมด] [-แพ็คเกจย่อย พีกก:พีกก:...] [-ไม่รวม pkglist]
[-การเข้ารหัส ชุดอักขระ] [-โลแคล ชื่อ] [ที่มา- ปล่อย]
[- สาธารณะ] [-มีการป้องกัน] [- แพคเกจ] [-เอกชน]
[-docletpath รายการเส้นทาง] [-doclet ชื่อคลาส]
[แพคเกจ... ] [ไฟล์ต้นฉบับ-cmdfile.php]
[ตัวเลือกเอกสาร]

gjdoc --ช่วยด้วย

gjdoc --รุ่น

เฉพาะตัวเลือกที่มีประโยชน์ที่สุดเท่านั้นที่แสดงไว้ที่นี่ ดูด้านล่างสำหรับส่วนที่เหลือ

DESCRIPTION

Gjdoc สามารถใช้ได้สองวิธี: เป็นเครื่องมือเอกสารแบบสแตนด์อโลน หรือเป็นไดรเวอร์สำหรับa
Doclet ที่ผู้ใช้ระบุ

ในโหมดเริ่มต้น Gjdoc จะใช้ Standard Doclet HTMLDoclet เพื่อสร้างชุดของ
หน้า HTML การใช้งานตามรูปแบบบัญญัติคือ:

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

ที่นี่ src/จาวา/ เป็นรูทของลำดับชั้นของคลาสซอร์สโค้ดของคุณ -ทั้งหมด หมายความว่าทั้งหมดถูกต้อง
ไฟล์ Java ที่พบในไดเรกทอรีรากนี้ควรได้รับการประมวลผลและ API-docs/ คือ
ไดเร็กทอรีที่ควรวางเอกสารที่สร้างขึ้น

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับการเรียกใช้ Doclets นอกเหนือจาก Standard Doclet ให้อ้างอิงกับคู่มือ

OPTIONS

ตัวเลือกเสริม (Option) สรุป by ชนิดภาพเขียน

นี่คือบทสรุปของตัวเลือกทั้งหมดของทั้ง Gjdoc และ Standard Doclet ซึ่งจัดกลุ่มโดย
พิมพ์. คำอธิบายอยู่ในส่วนต่อไปนี้

แหล่ง ชุด Options
-แหล่งที่มา รายการเส้นทาง -แพ็คเกจย่อย pkglist -ไม่รวม pkglist

แหล่ง รูปแบบ Options
ที่มา- ปล่อย -การเข้ารหัส การเข้ารหัส -ผู้ทำลาย

การเชื่อมโยงระหว่างกัน Options
ลิงค์ URL -linkออฟไลน์ URL ไฟล์ - ไม่มีคุณสมบัติ พีกก:พีกก:...

รุ่น Options
-ผู้เขียน -ข้อความใบอนุญาต -ใช้ -version -splitindex -ไม่มีดัชนี
-nodeprecated -nodeprecatedlist - ไม่ช่วย -ไม่มีนาฟบาร์
-nosince -โนทรี - สาธารณะ -มีการป้องกัน - แพคเกจ -เอกชน
-docfilessubdirs -ไม่รวมdocfilessubdir บอกฉัน
-ลิงค์ซอร์ส

เอาท์พุต Options
-d -โลแคล ชื่อ -ชุดอักขระ ชุดอักขระ - การเข้ารหัส ชุดอักขระ
-validhtml -baseurl URL

ตกแต่ง Options
-ชื่อหน้าต่าง ข้อความ -doctitle ข้อความ -ชื่อ ข้อความ
-หัวข้อ ข้อความ - ส่วนท้าย ข้อความ -ด้านล่าง ข้อความ
-ไฟล์ช่วยเหลือ ไฟล์ -สไตล์ชีทไฟล์ ไฟล์ -เพิ่มสไตล์ชีต ไฟล์
-กลุ่ม หัวเรื่องกลุ่ม pkgรูปแบบ:pkgรูปแบบ:...

แท็กเล็ต Options
-แท็กเล็ตพาธ -แท็กเล็ต ชื่อชั้น - แท็ก แท็กสเปค

ด็อกเล็ท Options
-docletpath -doclet ชื่อชั้น

คำฟุ่มเฟือย Options
-เงียบ -รายละเอียด

เสมือน เครื่อง Options
-คลาสพาธ -bootclasspath -J vmot

การเลือก ที่ แหล่ง ไฟล์ ไปยัง กระบวนการ

-s รายการเส้นทาง
-แหล่งที่มา รายการเส้นทาง
ค้นหาไฟล์ต้นฉบับในไดเร็กทอรีหรือไดเร็กทอรีที่ระบุ

รายการเส้นทาง ควรเป็นเส้นทางไดเรกทอรีอย่างน้อยหนึ่งเส้นทางที่คั่นด้วยเส้นทางของแพลตฟอร์มของคุณ
ตัวคั่น (โดยปกติ : or ;).

หากไม่ได้เลือกตัวเลือกนี้ gjdoc จะค้นหาไฟล์ต้นฉบับในปัจจุบัน
ไดเรกทอรี

ไดเร็กทอรีที่ระบุควรเป็นไดเร็กทอรีรูทในแง่ของแพ็คเกจ Java
ระบบ. ตัวอย่างเช่น หากคุณต้องการสร้างเอกสารสำหรับคลาสในแพ็คเกจ
ฟูบาร์คุณต้องระบุไดเร็กทอรีที่มีระดับบนสุด foo ไดเรกทอรีย่อย
ไม่ใช่ไดเรกทอรี ฟู/บาร์/ ที่มีไฟล์ต้นฉบับ Java อยู่

นามแฝงตัวย่อ -s มีความเฉพาะเจาะจงกับ gjdoc และเข้ากันไม่ได้กับ Sun จาวาด็อก.

-ทั้งหมด
[ทดลอง] ประมวลผลซอร์สไฟล์ Java ที่ถูกต้องทั้งหมดที่พบในไดเร็กทอรีที่ระบุไว้ใน
เส้นทางต้นทางและไดเรกทอรีย่อย

นี่เป็นตัวเลือกเฉพาะสำหรับ gjdoc และเข้ากันไม่ได้กับ Sun จาวาด็อก.

-แพ็คเกจย่อย พีกก:พีกก:...
ประมวลผลคลาสในแพ็คเกจ Java ที่กำหนดและแพ็คเกจย่อยทั้งหมดแบบวนซ้ำ
โปรดทราบว่าชื่อแพ็กเกจหลายชื่อต้องคั่นด้วยโคลอนแทนการเว้นวรรค

-ไม่รวม พีกก:พีกก:...
อย่าประมวลผลคลาสในแพ็คเกจ Java ที่กำหนดและแพ็คเกจย่อยทั้งหมดซ้ำ ๆ
สามารถใช้ตัวเลือกนี้ร่วมกับ -ทั้งหมด 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(สตริง).

-ผู้ทำลาย
ใช้ java.text.BreakIterator ของโลแคลแทนประโยคแรกภายใน
เครื่องตรวจจับ

โดยค่าเริ่มต้น gjdoc ใช้อัลกอริทึมภายในเพื่อกำหนดว่าประโยคสิ้นสุดที่ใด เมื่อไหร่
ให้ตัวเลือกนี้ มันจะใช้ .แทน java.text.BreakIterator ตัวอย่างสำหรับ
สถานที่ที่กำหนดด้วย -โลแคล (หรือโลแคลเริ่มต้น)

ควรระบุตัวเลือกนี้เมื่อสมัคร gjdoc เพื่อแสดงความคิดเห็นในซอร์สโค้ดที่ไม่ใช่
ภาษาละตินที่ตัวตรวจจับประโยคเริ่มต้นที่เป็นค่าเริ่มต้นไม่ทำงาน เพื่อทุกสิ่ง
กรณีอื่นๆ ค่าเริ่มต้น (อย่าใช้ BreakIterator) จะให้ผลลัพธ์ที่ดีกว่าที่
เวลาเขียนนี้

การเชื่อมโยงระหว่างกัน กับ อื่น ๆ เอกสาร ชุดอุปกรณ์

ลิงค์ URL
สร้างไฮเปอร์ลิงก์ไปยังชุดเอกสารอื่น

โดยค่าเริ่มต้น gjdoc จะสร้างไฮเปอร์ลิงก์ไปยังคลาสในชุดที่มาเท่านั้น ใช้สิ่งนี้
ตัวเลือกในการสร้างไฮเปอร์ลิงก์เพิ่มเติมไปยังคลาสที่ครอบคลุมโดยที่ระบุ
ชุดเอกสาร.

URL ควรเป็น URL รูทของชุดเอกสารอื่น เช่น เพิ่ม
ไฮเปอร์ลิงก์ไปยัง GNU Classpath ระบุสิ่งต่อไปนี้:

ลิงค์ http://developer.classpath.org/doc/

พื้นที่ ลิงค์ สามารถระบุตัวเลือกได้หลายครั้ง

โปรดทราบว่าการระบุ ลิงค์ ตัวเลือกจะทำให้เข้าถึง HTTP ทุกครั้งที่ gjdoc is
เรียก คุณสามารถใช้ได้ -linkออฟไลน์ แทนเพื่อหลีกเลี่ยงการเข้าถึงนี้

-linkออฟไลน์ URL ไฟล์
สร้างไฮเปอร์ลิงก์ไปยังชุดเอกสารอื่นซึ่งมีอยู่ในไฟล์ในเครื่องด้วย
ระบบ

ตัวเลือกนี้ทำงานเหมือนกับ ลิงค์ยกเว้นว่าจะเข้าถึงระบบไฟล์ในเครื่อง
แทนเครือข่ายเพื่อกำหนดว่าคลาสใดที่ครอบคลุมโดยลิงค์
ชุดเอกสาร.

เมื่อใช้ -linkออฟไลน์ ไม่สามารถเข้าถึงชุดเอกสารระยะไกลได้เลย ซึ่งสามารถ
เร่งเวลาในการสร้างได้อย่างมากขึ้นอยู่กับการเชื่อมต่อเครือข่ายของคุณ NS
สร้างไฮเปอร์ลิงก์ไปยังชุดเอกสาร แต่อ้างถึงชุดระยะไกล ไม่ใช่
ท้องถิ่นเพื่อให้คุณสามารถแจกจ่ายเอกสารโดยไม่ต้องเพิ่มเติม
การพึ่งพา

พื้นที่ -linkออฟไลน์ สามารถระบุตัวเลือกได้หลายครั้ง

- ไม่มีคุณสมบัติ พีกก:พีกก:...
อย่าระบุชื่อคลาสในแพ็คเกจที่กำหนดด้วยชื่อแพ็คเกจ

โดยค่าเริ่มต้น ชื่อคลาสจะแสดงอย่างไม่มีเงื่อนไขก็ต่อเมื่อคลาสนั้นเป็นส่วนหนึ่งของ
ชุดแหล่งที่มาหรือชุดเอกสารที่เชื่อมโยง และมีคุณสมบัติตามชื่อของมัน
ที่มีแพ็คเกจถ้าไม่ใช่ คุณสามารถใช้ตัวเลือกนี้เพื่อบังคับชื่อที่ไม่เหมาะสมได้
สำหรับชั้นเรียนแม้ว่าจะไม่ได้เป็นส่วนหนึ่งของชุดเอกสารก็ตาม

ตัวอย่างเช่น โดยปกติการอ้างอิงถึงคลาส String จะแสดงเป็น .ที่มีคุณสมบัติครบถ้วน
java.lang.String (เว้นแต่คุณจะเชื่อมโยงไปยังชุดเอกสารที่เหมาะสมโดยใช้ ลิงค์)
เพราะไม่ใช่ส่วนหนึ่งของชุดเอกสาร คุณสามารถระบุ - ไม่มีคุณสมบัติ
java.lang เพื่อแสดงการอ้างอิงเดียวกันเช่นเดียวกับ เชือก.

โปรดทราบว่าสำหรับชื่อคลาสที่ไม่มีเงื่อนไขทั้งหมด จะมีคำแนะนำเครื่องมือเมื่อคุณวาง
ตัวชี้เมาส์เหนือมันในเอกสาร HTML

- ไม่มีคุณสมบัติ ทั้งหมด
ละเว้นตัวระบุชื่อแพ็คเกจจากชื่อคลาสทั้งหมด

ระบุตัวเลือกนี้เพื่อละเว้นตัวระบุชื่อแพ็คเกจทั้งหมด

การเลือก ที่ ข้อมูล ไปยัง ผลิต

- สาธารณะ
รวมเฉพาะสมาชิกสาธารณะของคลาสสาธารณะในเอาต์พุต โดยค่าเริ่มต้น ป้องกัน
รวมสมาชิกชั้นเรียนไว้ด้วย

-มีการป้องกัน
รวมสมาชิกสาธารณะหรือสมาชิกที่ได้รับการคุ้มครองของชั้นเรียนสาธารณะในผลลัพธ์ นี้เป็น
ค่าเริ่มต้น.

- แพคเกจ
รวมสมาชิกสาธารณะที่ได้รับการคุ้มครองและแพ็คเกจส่วนตัวของสาธารณะและแพ็คเกจส่วนตัว
ชั้นเรียน

-เอกชน
รวมชั้นเรียนและสมาชิกชั้นเรียนทั้งหมดโดยไม่คำนึงถึงระดับการเข้าถึง

-splitindex
สร้างหน้าดัชนีหนึ่งหน้าต่อตัวอักษรแทนที่จะเป็นหน้าดัชนีแบบเสาหินหน้าเดียว

ตามค่าเริ่มต้น ดัชนีที่สร้างโดย Standard Doclet จะมีรายการทั้งหมดใน single
หน้าหนังสือ. นี่เป็นเรื่องปกติสำหรับชุดเอกสารขนาดเล็ก แต่สำหรับชุดใหญ่ คุณควร
ระบุตัวเลือกนี้

-nosince
ไม่สนใจ @ตั้งแต่ แท็กในความคิดเห็น javadoc

โดยค่าเริ่มต้น เอาต์พุตที่สร้างขึ้นมีส่วนที่แสดงเวอร์ชันของ API . ของคุณ
ตั้งแต่ที่แพ็คเกจ คลาส หรือสมาชิกคลาสที่เป็นปัญหามีอยู่เมื่อแท็กนี้เป็น
ได้พบเจอ ระบุตัวเลือกนี้เพื่อละเว้นข้อมูลนี้

-โนทรี
อย่าสร้างหน้าต้นไม้ใด ๆ

โดยค่าเริ่มต้น ผลลัพธ์ที่สร้างขึ้นจะรวมแผนผังการสืบทอดหนึ่งรายการต่อแพ็คเกจ และ - if
ชุดเอกสารประกอบด้วยหลายแพ็คเกจ - หน้าที่มีการสืบทอดแบบเต็ม
ต้นไม้. ระบุตัวเลือกนี้เพื่อละเว้นการสร้างเพจเหล่านี้

-ไม่มีดัชนี
อย่าส่งออกดัชนีตามตัวอักษร

โดยค่าเริ่มต้น gjdoc จะสร้างดัชนีตามตัวอักษรขององค์ประกอบโปรแกรมทั้งหมดในไฟล์
ชุดเอกสาร (แพ็คเกจ คลาส คลาสภายใน ตัวสร้าง เมธอด และ
ฟิลด์) ระบุตัวเลือกนี้เพื่อละเว้นข้อมูลนี้

- ไม่ช่วย
อย่าสร้างหน้าความช่วยเหลือ

ขณะนี้ตัวเลือกนี้ถูกละเว้นเนื่องจาก Standard Doclet ไม่มีหน้าความช่วยเหลือ

-nodeprecated
ห้ามแสดงข้อมูลแบบอินไลน์เกี่ยวกับแพ็กเกจ คลาส หรือสมาชิกคลาสที่เลิกใช้แล้ว

โดยค่าเริ่มต้น Doclet มาตรฐานจะเพิ่มย่อหน้าที่เน้นด้วยการเลิกใช้
ข้อมูลคำอธิบายขององค์ประกอบโปรแกรมที่เลิกใช้แต่ละรายการ ระบุสิ่งนี้
ตัวเลือกที่จะละเว้นข้อมูลนี้

-nodeprecatedlist
อย่าส่งออกหน้าสรุปสำหรับองค์ประกอบ API ที่เลิกใช้แล้ว

โดยค่าเริ่มต้น Doclet มาตรฐานจะสร้างหน้าที่แสดงรายการองค์ประกอบ API ที่เลิกใช้ทั้งหมด
พร้อมกับคำอธิบายการเลิกใช้งานซึ่งมักจะรวมถึงเหตุผลในการเลิกใช้
และทางเลือกอื่นที่เป็นไปได้ ระบุตัวเลือกนี้เพื่อละเว้นข้อมูลนี้

-ไม่มีนาฟบาร์
ห้ามแสดงแถบนำทาง ส่วนหัว และส่วนท้าย

โดยค่าเริ่มต้น หน้าผลลัพธ์แต่ละหน้าจะมีแถบนำทางด้านบน (ซึ่งอาจรวมถึง
ส่วนหัวที่ผู้ใช้ระบุ) และแถบการนำทางด้านล่าง (ซึ่งอาจรวมถึงผู้ใช้-
ส่วนท้ายที่ระบุ) ระบุตัวเลือกนี้เพื่อละเว้นการตกแต่งนี้

-ไม่มีความเห็น
ละเว้นข้อความเอกสารทั้งหมดจากไฟล์ที่สร้างขึ้นและส่งออกเฉพาะการประกาศและ
ความสัมพันธ์ขององค์ประกอบของโปรแกรม

ตัวเลือกนี้มีไว้สำหรับความเข้ากันได้กับ จาวาด็อก. หากคุณวางแผนที่จะสกัด
ข้อมูลเกี่ยวกับโครงการของคุณผ่าน gjdocคุณควรพิจารณาใช้ Doclet . อื่น
เพื่อวัตถุประสงค์ของคุณแทน เช่น XmlDoclet คุณสามารถใช้ Doclet API
โดยตรงโดยใช้ Doclet ใหม่

-ลิงค์ซอร์ส
สร้างเพจที่มีซอร์สโค้ดเน้นไวยากรณ์สำหรับแต่ละคลาส โดยค่าเริ่มต้น this
ไม่ได้สร้างหน้า

สามารถเข้าถึงซอร์สโค้ดได้โดยคลิกที่ปุ่ม "Source" ใน
แถบนำทาง หรือโดยการคลิกที่ชื่อคอนสตรัคเตอร์ ฟิลด์ เมธอด หรือ inner
class ในส่วนรายละเอียดของหน้าเอกสารประกอบการเรียน

-ใช้
สร้างเพจที่มีข้อมูลอ้างอิงโยง โดยค่าเริ่มต้น หน้านี้ไม่ใช่
สร้างขึ้น

ข้อมูลอ้างอิงโยงสามารถเข้าถึงได้โดยคลิกที่ปุ่มที่มีข้อความ
'ใช้' ในแถบนำทาง

หน้า `ใช้' แสดงรายการคลาส/อินเทอร์เฟซทั้งหมดในชุดเอกสารที่
ขยาย/ปรับใช้คลาส (ประเภท) ที่เป็นปัญหา ฟิลด์ของประเภท; วิธีการหรือ
ตัวสร้างยอมรับพารามิเตอร์ของประเภท วิธีการส่งคืนประเภท; และ
วิธีการหรือตัวสร้างขว้างประเภท

-ผู้เขียน
รวมข้อมูลผู้เขียนในผลลัพธ์

เมื่อระบุข้อมูลผู้เขียนตามที่ระบุโดยใช้ @ผู้เขียน แท็กใน javadoc
ความคิดเห็นรวมอยู่ในผลลัพธ์ โดยค่าเริ่มต้น, @ผู้เขียน แท็กจะถูกละเว้น

-version
รวมข้อมูลเวอร์ชันในผลลัพธ์

เมื่อระบุ ข้อมูลเวอร์ชันตามที่ระบุโดยใช้คำสั่ง @เวอร์ชั่น แท็กใน javadoc
ความคิดเห็นรวมอยู่ในผลลัพธ์ โดยค่าเริ่มต้น, @เวอร์ชั่น แท็กจะถูกละเว้น

-ข้อความใบอนุญาต
สมมติว่าความคิดเห็นแรกในไฟล์ต้นฉบับแต่ละไฟล์มีข้อความใบอนุญาต และเพิ่ม
ข้อมูลใบอนุญาตที่ส่วนท้ายของหน้าชั้นเรียนที่สร้างขึ้นแต่ละหน้า

นี่เป็นตัวเลือกเฉพาะสำหรับ gjdoc และเข้ากันไม่ได้กับ Sun จาวาด็อก.

ตัวเลือกนี้มีไว้สำหรับใช้กับโปรเจ็กต์โอเพ่นซอร์สฟรีที่มีซอร์สโค้ด
มักจะนำหน้าด้วยความคิดเห็นใบอนุญาตสำเร็จรูป เมื่อมีเหตุผลทางกฎหมาย
เพื่อรวมใบอนุญาตไว้ในเอกสาร

-docfilessubdirs
คัดลอกไฟล์ทั้งหมดใน .ซ้ำๆ ไฟล์เอกสาร ไดเร็กทอรีย่อยของแต่ละไดเร็กทอรีแพ็คเกจ

โดยปกติเฉพาะไฟล์ใน ไฟล์เอกสาร ไดเร็กทอรีย่อยจะถูกคัดลอกโดยไม่ลดทอนลง
เรียกซ้ำ

-ไม่รวมdocfilessubdir ชื่อ:ชื่อ: ...
อย่าคัดลอกบางไดเร็กทอรีโดยตรงภายใต้ the ไฟล์เอกสาร ไดเรกทอรีย่อยเมื่อ
จากมากไปน้อยซ้ำแล้วซ้ำอีก

อาร์กิวเมนต์ของตัวเลือกนี้ควรเป็นรายการชื่อไดเร็กทอรีที่คั่นด้วยเครื่องหมายทวิภาค

ตัวเลือกนี้เหมาะสมก็ต่อเมื่อ -docfilessubdirs ระบุไว้ด้วย ในกรณีนี้ ใดๆ
ไดเร็กทอรีย่อยที่อยู่ใต้a ไฟล์เอกสาร ไดเร็กทอรีจะถูกละเว้นหากอยู่ในรายการ

ประเพณี เอกสาร แท็ก

-แท็กเล็ตพาธ รายการเส้นทาง
ค้นหา รายการเส้นทาง เมื่อโหลดคลาส Taglet ที่ตามมาที่ระบุโดยใช้ -แท็กเล็ต.

รายการเส้นทาง ควรเป็นอย่างน้อยหนึ่งเส้นทางไปยังไดเร็กทอรีหรือไฟล์ jar คั่นด้วย your
ตัวคั่นเส้นทางของแพลตฟอร์ม (โดยปกติ : or ;).

-แท็กเล็ต ชื่อชั้น
ลงทะเบียน Taglet

ชื่อชั้น ควรเป็นชื่อที่มีคุณสมบัติครบถ้วนของการนำคลาส Java ไปใช้งาน
com.sun.tools.doclets.Taglet.

คลาส Taglet จะถูกโหลดจาก classpath ที่ระบุโดยใช้ -แท็กเล็ตพาธจาก
classpath ที่ระบุโดยใช้ -คลาสพาธ และจาก classpath เริ่มต้น

ดูเอกสารของ com.sun.tools.doclets.Taglet สำหรับข้อมูลเพิ่มเติม.

โปรดทราบว่าสำหรับแท็กง่าย ๆ ก็ยังมี - แท็ก.

- แท็ก แท็กสเปค
ลงทะเบียน Taglet ทั่วไป

รูปแบบของ แท็กสเปค จะต้องเป็น : :" ".

ชื่อแท็ก เป็นชื่อแท็กที่ตรงกันโดยไม่มีเครื่องหมาย @ นำหน้า

ธง เป็นอักขระต่อไปนี้ตั้งแต่หนึ่งตัวขึ้นไป โดยที่อักขระแต่ละตัวระบุ a
บริบทของซอร์สโค้ดที่จะรู้จักแท็ก

a ทุกบริบท

c ก่อสร้าง

f ทุ่ง

m วิธีการ

o ภาพรวม

p แพคเกจ

t ประเภท (คลาส อินเตอร์เฟส ข้อยกเว้น ข้อผิดพลาด)

X อักขระพิเศษที่ปิดใช้งาน Taglet ทั้งหมดชั่วคราว

หัวแท็ก เป็นสตริงที่แสดงในส่วนหัวของส่วนที่เกี่ยวข้องกับแท็กใน
คำถาม.

ตัวอย่างเช่น ในการกำหนดแท็กที่ตรงกัน @cvsid ซึ่งเป็นที่ยอมรับในภาพรวม
แพ็คเกจและพิมพ์หน้าซึ่งมีป้ายกำกับว่าส่วนหัว CVS ID, คุณจะ
ระบุ:

-แท็ก cvsid:tpo:"CVS ID"

สมมติว่าความคิดเห็นของคลาส javadoc มี

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew ประสบการณ์ $

จากนั้นเอาต์พุต HTML จะมีบางอย่างเช่น

รหัส CVS:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew ประสบการณ์ $

เล่น อื่นๆ เอกสาร

-docletpath รายการเส้นทาง
ค้นหา รายการเส้นทาง เมื่อโหลดคลาสสำหรับ Doclet ที่ระบุโดยใช้ -doclet.

รายการเส้นทาง ควรเป็นอย่างน้อยหนึ่งเส้นทางไปยังไดเร็กทอรีหรือไฟล์ jar คั่นด้วย your
ตัวคั่นเส้นทางของแพลตฟอร์ม (โดยปกติ : or ;).

-doclet ชื่อคลาส
เรียกใช้ doclet ที่ระบุแทน HtmlDoclet มาตรฐาน

ชื่อคลาส ควรเป็นชื่อที่มีคุณสมบัติครบถ้วนของคลาสที่มีการผิดนัดสาธารณะ
ตัวสร้างและมีวิธีการที่มีลายเซ็นต่อไปนี้:

นำเข้า com.sun.javadoc.RootDoc;
การเริ่มต้นบูลีนแบบคงที่สาธารณะ (RootDoc ​​rootDoc)

คลาส Doclet จะถูกโหลดจาก classpath ที่ระบุโดยใช้ -docletpathจาก
classpath ที่ระบุโดยใช้ -คลาสพาธ และจาก classpath เริ่มต้น

พื้นที่ เริ่มต้น วิธีควรประมวลผลข้อมูลที่เปิดเผยโดย Doclet API ผ่าน รูตด็อก
และการกลับมา จริง เมื่อประสบความสำเร็จ เท็จ เมื่อล้มเหลว

หากคุณกำลังใช้เอกสารของบุคคลที่สาม โปรดดูเอกสารประกอบสำหรับข้อมูลเพิ่มเติม
คำแนะนำ. โปรดทราบว่าการรองรับ doclets บุคคลที่สามนั้นอยู่ในขั้นทดลอง โปรด
รายงานปัญหาใด ๆ ที่คุณพบ หรือให้ข้อเสนอแนะเมื่อทำงานสำเร็จ
แอปเพล็ตบุคคลที่สาม

ตัวเลือกนี้สามารถระบุได้หลายครั้ง ซึ่งในกรณีนี้ doclets ทั้งหมดจะถูกดำเนินการ
ด้วยแผนผังข้อมูลเดียวกันที่เปิดเผยผ่าน Doclet API สำหรับการเรียกใช้ Doclet แต่ละครั้ง

เพิ่ม ข้อมูล ไปยัง เอาท์พุต

-ชื่อหน้าต่าง ข้อความ
ใช้ ข้อความ เป็นคำนำหน้าชื่อหน้าต่างเบราว์เซอร์

เมื่อระบุแล้ว ชื่อหน้าต่างเบราว์เซอร์สำหรับแต่ละหน้าจะขึ้นต้นด้วย ข้อความ
แทนสตริงเริ่มต้น สร้าง API เอกสาร.

ข้อความ ควรเป็นข้อความธรรมดา (ไม่ควรมีแท็ก HTML)

-doctitle ข้อความ
ตั้งค่าข้อความส่วนหัวของหน้าภาพรวมเป็น ข้อความ.

ข้อความ ควรเป็นสตริงข้อความธรรมดาแบบสั้น

เมื่อสร้างเอกสารสำหรับแพ็คเกจเดียว ระบุตัวเลือกนี้บังคับ
การสร้างหน้าภาพรวม

-หัวข้อ htmlข้อความ
เพิ่ม htmlข้อความ ที่มุมบนขวาของทุกหน้าที่สร้างขึ้น htmlข้อความ มักจะ
กำหนดเป็นชื่อโครงการที่จัดทำเป็นเอกสาร

- ส่วนท้าย htmlข้อความ
เพิ่ม htmlข้อความ ที่มุมล่างขวาของทุกหน้าที่สร้างขึ้น htmlข้อความ บ่อยๆ
ตั้งเป็นค่าเดียวกับfor -หัวข้อ.

-ด้านล่าง htmlข้อความ
เพิ่ม htmlข้อความ จนถึงด้านล่างสุดของทุกหน้าที่สร้างขึ้น โดยครอบคลุมความกว้างทั้งหมดของ
หน้า. เมื่อกำหนด htmlข้อความ มักจะประกอบด้วยประกาศเกี่ยวกับลิขสิทธิ์และ/หรือ
ลิงค์ไปยังหน้าโครงการอื่น ๆ

-เพิ่มสไตล์ชีต ไฟล์
เพิ่มสไตล์ชีต CSS เริ่มต้นด้วยสไตล์ชีตที่ผู้ใช้ระบุ ไฟล์.

สไตล์ชีตที่กำหนดนั้นถูกโหลดโดยแต่ละหน้า HTML นอกเหนือจากค่าเริ่มต้น
เป็นสไตล์ชีตสุดท้าย

โปรดทราบว่าใช้กฎการเรียงซ้อน CSS นั่นคือคุณสมบัติสไตล์ของคุณจะเป็น
กำหนดถ้าพวกเขามีลำดับการเรียงซ้อนที่สูงกว่า gjdocสไตล์เริ่มต้นของ ง่ายนิดเดียว
วิธีตรวจสอบให้แน่ใจว่าในกรณีนี้คือการประกาศการแทนที่ของคุณ ที่สำคัญ!.

ดูhttp://www.w3.org/TR/REC-CSS2/cascade.html#เรียงตามลำดับ>.

-กลุ่ม หัวเรื่อง pkgไวด์การ์ด:pkgไวด์การ์ด: ...
จัดเรียงแพ็คเกจที่กำหนดในกลุ่มแยกต่างหากในหน้าภาพรวม

อาร์กิวเมนต์แรกควรเป็นข้อความธรรมดาสั้นๆ ที่ใช้เป็นชื่อเรื่องของ
กลุ่มบรรจุภัณฑ์ อาร์กิวเมนต์ที่สองควรเป็นรายการ package . ที่คั่นด้วยโคลอน
ตัวแทน กลุ่มจะประกอบด้วยแพ็คเกจทั้งหมดในชุดเอกสารที่มีชื่อ
ตรงกับไวด์การ์ดที่ระบุ

มีอักขระตัวแทนเพียงตัวเดียวเท่านั้น *ซึ่งตรงกับตัวอักษรทั้งสองในชื่อแพ็คเกจ
ส่วนประกอบและ . การแยกส่วนประกอบชื่อแพ็คเกจ ตัวอย่างเช่น, j * regex จะ
แพ็คเกจจับคู่ java.util.regex. ตัวอย่างที่เป็นประโยชน์มากขึ้นจะเป็น javax.สวิง* เพื่อให้ตรงกับ
javax.สวิง และแพ็คเกจย่อยทั้งหมด

ตัวเลือกนี้สามารถให้ได้หลายครั้ง

FIXME: ข้อมูลเกี่ยวกับการซ้อนกลุ่มที่นี่

gjdoc - กลุ่ม "คลาสหลัก" 'java*' \
-group "สวิง" 'javax.swing*' \
- กลุ่ม "XML API" 'javax.xml*' \
-group "ส่วนขยายอื่นๆ" javax* \
...

-ภาพรวม ไฟล์
เพิ่มส่วนเนื้อหา XHTML จาก ไฟล์ ไปที่หน้าภาพรวม

ไฟล์ ควรมีแฟรกเมนต์ XHTML ที่มี HTML ร่างกาย แท็กเป็นโหนดรูท

ตัวเลือกนี้สามารถใช้เพื่อระบุรายละเอียดของชุดเอกสารโดยรวม

เมื่อกำหนด ประโยคแรกของส่วนจะวางเหนือตาราง
แสดงรายการแพ็คเกจที่จัดทำเป็นเอกสารพร้อมกับลิงก์ไปยังสำเนาเต็มของชิ้นส่วน
ซึ่งวางอยู่ใต้ตาราง

เมื่อสร้างเอกสารสำหรับแพ็คเกจเดียว ระบุตัวเลือกนี้บังคับ
การสร้างหน้าภาพรวม

-สไตล์ชีทไฟล์ ไฟล์
ใช้สไตล์ชีต CSS ใน ไฟล์ แทนที่จะเป็นสไตล์ชีต CSS เริ่มต้น

หากคุณต้องการแทนที่บางส่วนของสไตล์ชีตเริ่มต้น ให้ใช้ -เพิ่มสไตล์ชีต
แทน.

-ชื่อ ข้อความ
เลิกใช้แล้ว ใช้ -doctitle ข้อความ แทน.

-ไฟล์ช่วยเหลือ ไฟล์
ขณะนี้ตัวเลือกนี้ถูกละเว้น

เมื่อดำเนินการแล้วจะใช้ส่วนย่อย XHTML ใน ไฟล์ สำหรับเนื้อหาหน้าช่วยเหลือ
แทนที่จะเป็นข้อความช่วยเหลือเริ่มต้น

การควบคุม เอาท์พุต

-d ไดเรกทอรี
วางไฟล์เอาท์พุตทั้งหมดลงใน ไดเรกทอรี (และไดเรกทอรีย่อย) ไดเรกทอรี จะถูกสร้างขึ้น
หากไม่มีอยู่ รวมถึงไดเร็กทอรีหลักที่ไม่มีอยู่ทั้งหมดและทั้งหมดที่จำเป็น
ไดเรกทอรีย่อย

หากไม่ได้ระบุไว้ เอาต์พุตจะถูกวางลงในไดเร็กทอรีปัจจุบัน

-โลแคล ชื่อ
ใช้สถานที่ ชื่อ แทนที่จะเป็นโลแคลเริ่มต้นสำหรับวัตถุประสงค์ทั้งหมด

ชื่อ ควรเป็นตัวระบุสถานที่ในรูปแบบ ll_CC[_VAR] ที่ไหน ll เป็นตัวพิมพ์เล็กสอง-
รหัสภาษาตัวอักษร ISO-639, CC เป็นประเทศ ISO-3166 ตัวพิมพ์ใหญ่สองตัวที่เป็นตัวเลือก
รหัสและ VAR เป็นรหัสตัวแปรเสริม ตัวอย่างเช่น, en ระบุภาษาอังกฤษ en_US
ระบุภาษาอังกฤษแบบสหรัฐอเมริกาและ th_US_WIN ระบุความแตกต่างของภาษาอังกฤษแบบสหรัฐอเมริกา
สถานที่

โปรดทราบว่าความหมายของตัวเลือกนี้ตรงกับความหมายของคอนสตรัคเตอร์
ของชั้นเรียน java.util.Locale.

ปัจจุบันตัวเลือกนี้กำหนดว่า Collator ใดที่ใช้สำหรับการเรียงลำดับเอาต์พุต
องค์ประกอบ ซึ่งหมายความว่าโลแคลจะมีผลเฉพาะเมื่อคุณใช้ non-
อักขระ ASCII ในตัวระบุ

-ชุดอักขระ ชุดอักขระ
เลิกใช้แล้ว แทนที่การเข้ารหัสที่ระบุในไฟล์ XHTML เอาต์พุตด้วยรหัสที่กำหนด
by ชุดอักขระ.

หากไม่ระบุตัวเลือกนี้ จะเลือกข้อกำหนดการเข้ารหัสในเอาต์พุต XHTML เป็น
จับคู่การเข้ารหัสที่ใช้เมื่อเขียนไฟล์ (การเข้ารหัสที่กำหนดด้วย - การเข้ารหัส,
หรือการเข้ารหัสเริ่มต้นของแพลตฟอร์มของคุณ)

ความหมายสำหรับ ชุดอักขระ ระบุไว้ที่นี่:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. เพื่อวัตถุประสงค์ในทางปฏิบัติทั้งหมด
เหมือนกับตัวเลือกอื่นๆ ที่ยอมรับพารามิเตอร์ชุดอักขระ

ตัวเลือกนี้มีไว้สำหรับความเข้ากันได้กับ จาวาด็อก และควรหลีกเลี่ยง

- การเข้ารหัส ชุดอักขระ
ใช้การเข้ารหัสชุดอักขระที่กำหนดเมื่อเขียนไฟล์เอาต์พุตแทนแพลตฟอร์ม
การเข้ารหัสเริ่มต้น

ตัวอย่างสำหรับ ชุดอักขระ เป็น 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
เดินสาย URL ของเพจที่สัมพันธ์กับ URL ในแต่ละหน้าที่สร้างขึ้น

หากคุณกำลังสร้างเอกสารที่จะสามารถใช้ได้เฉพาะที่บาง
URL คุณควรใช้ตัวเลือกนี้เพื่อระบุ URL นี้

วิธีนี้จะช่วยหลีกเลี่ยงการโจมตีเปลี่ยนเส้นทางที่นักส่งสแปมใช้ และมีประโยชน์
สำหรับเว็บไคลเอ็นต์บางตัว

คำฟุ่มเฟือย Options

-เงียบ
ระงับเอาต์พุตทั้งหมด ยกเว้นคำเตือนและข้อความแสดงข้อผิดพลาด

-รายละเอียด
ละเอียดมากเกี่ยวกับสิ่งที่ gjdoc กำลังทำ.

ขณะนี้ตัวเลือกนี้ถูกละเว้น

เสมือน เครื่อง Options

ซัน จาวาด็อก เครื่องมือดูเหมือนว่าจะขึ้นอยู่กับ จาวัค และดูเหมือนว่าจะทำงานบน VM
ชั้น gjdocในทางตรงกันข้าม เป็นแอปพลิเคชัน Java ล้วนๆ

ดังนั้น gjdoc สามารถปลอมหรือจำลองได้เฉพาะตัวเลือกระดับ VM ต่อไปนี้

-คลาสพาธ รายการเส้นทาง
ตั้งค่าเครื่องเสมือน เส้นทางคลาส ไปยัง รายการเส้นทาง.

ในกรณีส่วนใหญ่คุณควรใช้ -docletpath or -แท็กเล็ตพาธ แทนตัวเลือกนี้

รายการเส้นทาง ควรเป็นอย่างน้อยหนึ่งเส้นทางไปยังไดเร็กทอรีหรือไฟล์ jar คั่นด้วย your
ตัวคั่นเส้นทางของแพลตฟอร์ม (โดยปกติ : or ;).

หากตัวเลือกนี้ไม่ถูกสกัดกั้นที่ระดับเสื้อคลุม gjdoc ปัจจุบันปลอมโดย
โทร System.setProperty("java.class.path", รายการเส้นทาง); และออกคำเตือน

-bootclasspath รายการเส้นทาง
ตั้งค่าเครื่องเสมือน เส้นทางบูตคลาส ไปยัง รายการเส้นทาง.

หากตัวเลือกนี้ไม่ถูกสกัดกั้นที่ระดับเสื้อคลุม gjdoc ส่งออกคำเตือน

-Jvmot
ส่งพารามิเตอร์ที่กำหนดเองไปยัง Virtual Machine gjdoc วิ่งบน

หากตัวเลือกนี้ไม่ถูกสกัดกั้นที่ระดับเสื้อคลุม gjdoc พยายามเลียนแบบ
ตัวเลือกและส่งออกคำเตือน

ปัจจุบัน เฉพาะตัวเลือก VM -D สำหรับการตั้งค่าคุณสมบัติของระบบจะถูกจำลอง

ใช้ gjdoc-4.8 ออนไลน์โดยใช้บริการ onworks.net