gjdoc-4.8 - Trực tuyến trên Đám mây

CHƯƠNG TRÌNH:

TÊN

cp-tools - Hướng dẫn Công cụ GNU Classpath

SYNOPSIS

gjdoc [-đường dẫn nguồn danh sách đường dẫn]
[-tất cả] [-các gói hàng pkg: pkg: ...] [-loại trừ danh sách pkg]
[-mã hóa bảng chữ cái] [-địa phương tên] [-Source phát hành]
[-công cộng] [-được bảo vệ] [-gói] [-riêng tư]
[-tiêu đề văn bản] [-cái đầu văn bản] [-chân trang văn bản] [-đáy văn bản]
[liên kết url] [-link ngoại tuyến url con đường] [-qualifier pkg: pkg: ...]
[-tagletpath danh sách đường dẫn] [-taglet tên lớp] [-nhãn thông số thẻ]
[-sử dụng] [-liên kết nguồn] [-splitindex] [-noindex] [-không đồng ý]
[-phiên bản] [-tác giả] [-nó] [-thêm biểu định kiểu hồ sơ]
[-d mục tiêu]
[gói...] [tập tin nguồn...] [@tập tin cmd]

gjdoc [-đường dẫn nguồn danh sách đường dẫn]
[-tất cả] [-các gói hàng pkg: pkg: ...] [-loại trừ danh sách pkg]
[-mã hóa bảng chữ cái] [-địa phương tên] [-Source phát hành]
[-công cộng] [-được bảo vệ] [-gói] [-riêng tư]
[-docletpath danh sách đường dẫn] [-doclet tên lớp]
[gói...] [tập tin nguồn...] [@tập tin cmd]
[tùy chọn doclet]

gjdoc --Cứu giúp

gjdoc --phiên bản

Chỉ những tùy chọn hữu ích nhất được liệt kê ở đây; xem phần còn lại bên dưới.

MÔ TẢ

Gjdoc có thể được sử dụng theo hai cách: làm công cụ tài liệu độc lập hoặc trình điều khiển cho
Doclet do người dùng chỉ định.

Ở chế độ mặc định, Gjdoc sẽ sử dụng Tài liệu chuẩn HtmlDoclet để tạo ra một tập hợp
Các trang HTML. Cách sử dụng chính tắc là:

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

Ở đây, src / java / là gốc của hệ thống phân cấp lớp mã nguồn của bạn, -tất cả có nghĩa là tất cả đều hợp lệ
Các tệp Java được tìm thấy trong thư mục gốc này phải được xử lý, và api-docs / là
thư mục nơi tài liệu đã tạo sẽ được đặt.

Để tìm hiểu thêm về cách chạy các Tài liệu khác với Tài liệu chuẩn, hãy tham khảo hướng dẫn sử dụng.

LỰA CHỌN

Tùy chọn Tổng kết by Kiểu

Dưới đây là tóm tắt về tất cả các tùy chọn của cả Gjdoc và Tài liệu chuẩn, được nhóm theo
kiểu. Giải thích có trong các phần sau.

nguồn Thiết lập Các lựa chọn
-đường dẫn nguồn danh sách đường dẫn -các gói hàng danh sách pkg -loại trừ danh sách pkg

nguồn Định dạng Các lựa chọn
-Source phát hành -mã hóa mã hóa -máy phá sóng

Liên kết với nhau Các lựa chọn
liên kết url -link ngoại tuyến url hồ sơ -qualifier pkg: pkg: ...

Thế hệ Các lựa chọn
-tác giả -giấy phép văn bản -sử dụng -phiên bản -splitindex -noindex
-không được tán thành -nodeprecatedlist -không giúp đỡ -thanh điều hướng
-nó -không đồng ý -công cộng -được bảo vệ -gói -riêng tư
-docfilessubdirs -excludedocfilessubdir nói cho tôi
-liên kết nguồn

Đầu ra Các lựa chọn
-d -địa phương tên -bộ ký tự bảng chữ cái -mã hóa tài liệu bảng chữ cái
-validhtml -baseurl url

Trang trí Các lựa chọn
-tiêu đề cửa sổ văn bản -tiêu đề văn bản -chức vụ văn bản
-cái đầu văn bản -chân trang văn bản -đáy văn bản
-tệp trợ giúp hồ sơ -tệp biểu định kiểu hồ sơ -thêm biểu định kiểu hồ sơ
-nhóm phân nhóm pkgpattern: pkgpattern: ...

Taglet Các lựa chọn
-tagletpath -taglet tên lớp -nhãn thông số thẻ

tài liệu Các lựa chọn
-docletpath -doclet tên lớp

Độ dài Các lựa chọn
-Yên lặng -bèo thuyền

ảo Các lựa chọn
-classpath -bootclasspath -J vmopt

Chọn cái nào nguồn Các tập tin đến Quy trình xét duyệt

-s danh sách đường dẫn
-đường dẫn nguồn danh sách đường dẫn
Tìm kiếm các tệp nguồn trong thư mục hoặc các thư mục được chỉ định.

danh sách đường dẫn phải là một hoặc nhiều đường dẫn thư mục được phân tách bằng đường dẫn nền tảng của bạn
dấu phân cách (thường là : or ;).

Nếu tùy chọn này không được đưa ra, gjdoc sẽ tìm kiếm các tệp nguồn trong hiện tại
thư mục.

Các thư mục được chỉ định phải là thư mục gốc trong điều kiện của gói Java
hệ thống. Ví dụ: nếu bạn muốn tạo tài liệu cho các lớp trong gói
foo.bar, bạn phải chỉ định thư mục chứa cấp cao nhất foo thư mục con,
không phải thư mục foo / bar / trong đó các tệp nguồn Java cư trú.

Bí danh tay ngắn -s là cụ thể cho gjdoc và không tương thích với Sun javadoc.

-tất cả
[THỰC NGHIỆM] Xử lý tất cả các tệp nguồn Java hợp lệ được tìm thấy trong các thư mục được liệt kê trong
đường dẫn nguồn và các thư mục con của chúng.

Đây là một tùy chọn dành riêng cho gjdoc và không tương thích với Sun javadoc.

-các gói hàng pkg: pkg: ...
Xử lý các lớp trong các gói Java đã cho và tất cả các gói con, một cách đệ quy.
Lưu ý rằng nhiều tên gói phải được phân tách bằng dấu hai chấm thay vì khoảng trắng.

-loại trừ pkg: pkg: ...
Không xử lý các lớp trong các gói Java đã cho và tất cả các gói con, một cách đệ quy.
Tùy chọn này có thể được sử dụng cùng với -tất cả or -các gói hàng để loại trừ
gói riêng lẻ hoặc gói cây con từ đầu ra.

góihữu ích. Cảm ơn !
Xử lý tất cả các lớp trong các gói Java đã cho.

tập tin nguồnhữu ích. Cảm ơn !
Xử lý các lớp trong các tệp nguồn Java đã cho.

Chỉ định các Định dạng of Đầu vào Các tập tin

-Source phát hành
Giả sử rằng các tệp nguồn được nhắm mục tiêu vào bản phát hành nhất định của nền tảng Java.

phát hành phải là số phiên bản của một bản phát hành nền tảng Java ở định dạng
MAJOR.MINOR chẳng hạn 1.4.

Tùy chọn này hiện bị bỏ qua ngoại trừ lỗi được phát sinh nếu số phát hành
khác hơn 1.2, 1.3 or 1.4 được quy định.

-mã hóa bảng chữ cái
Giả sử rằng các tệp nguồn được mã hóa bằng cách sử dụng bảng chữ cái.

Ví dụ cho bảng chữ cái đang US-ASCII, ISO-8859-1 or UTF-8.

Ngữ nghĩa của bảng chữ cái giống với những người của
java.nio.charset.Charset.forName (Chuỗi).

-máy phá sóng
Sử dụng java.text.BreakIterator của ngôn ngữ thay vì câu đầu tiên bên trong
máy dò.

Theo mặc định, gjdoc sử dụng một thuật toán nội bộ để xác định vị trí kết thúc một câu. Khi nào
tùy chọn này được đưa ra, thay vào đó nó sẽ sử dụng java.text.BreakIterator ví dụ cho
ngôn ngữ được đưa ra với -địa phương (hoặc ngôn ngữ mặc định).

Tùy chọn này nên được chỉ định khi áp dụng gjdoc đến mã nguồn được nhận xét trong một
ngôn ngữ latin mà trình dò ​​câu đầu tiên mặc định không hoạt động. Cho tất cả
các trường hợp khác, mặc định (không sử dụng BreakIterator) tạo ra kết quả tốt hơn ở
thời gian của bài viết này.

Liên kết với nhau với khác Tài liệu bộ

liên kết url
Tạo siêu liên kết đến một bộ tài liệu khác.

Theo mặc định, gjdoc sẽ chỉ tạo siêu liên kết đến các lớp trong tập nguồn. Dùng cái này
tùy chọn để tạo thêm các siêu liên kết đến các lớp được bao phủ bởi
bộ tài liệu.

url phải là URL gốc của bộ tài liệu khác. Ví dụ, để thêm
siêu liên kết đến GNU Classpath, chỉ định như sau:

liên kết http://developer.classpath.org/doc/

Sản phẩm liên kết tùy chọn có thể được chỉ định nhiều lần.

Lưu ý rằng chỉ định liên kết tùy chọn sẽ tạo ra một quyền truy cập HTTP mỗi khi gjdoc
được gọi. Bạn có thể dùng -link ngoại tuyến thay vào đó để tránh quyền truy cập này.

-link ngoại tuyến url hồ sơ
Tạo siêu liên kết đến một bộ tài liệu khác cũng có trên tệp cục bộ
hệ thống.

Tùy chọn này hoạt động giống hệt như liên kết, ngoại trừ việc nó truy cập vào hệ thống tệp cục bộ
thay vì mạng để xác định lớp nào được bao phủ bởi
bộ tài liệu.

Khi đang sử dụng -link ngoại tuyến bộ tài liệu từ xa hoàn toàn không được truy cập, điều này có thể
tăng tốc đáng kể thời gian tạo tùy thuộc vào kết nối mạng của bạn. Các
các siêu liên kết được tạo đến tập tài liệu tuy nhiên tham chiếu đến tập từ xa, không phải
tài liệu cục bộ để bạn có thể phân phối tài liệu mà không cần thêm bất kỳ
sự phụ thuộc.

Sản phẩm -link ngoại tuyến tùy chọn có thể được chỉ định nhiều lần.

-qualifier pkg: pkg: ...
Không đủ điều kiện tên của các lớp trong các gói đã cho với tên gói của chúng.

Theo mặc định, tên lớp chỉ được hiển thị không đủ tiêu chuẩn nếu lớp đó là một phần của
bộ nguồn hoặc bộ tài liệu được liên kết và đủ tiêu chuẩn với tên của
gói chứa nếu nó không phải là. Bạn có thể sử dụng tùy chọn này để buộc những tên không đủ tiêu chuẩn
cho các lớp ngay cả khi chúng không phải là một phần của bộ tài liệu.

Ví dụ: thông thường một tham chiếu đến lớp String được biểu diễn đầy đủ điều kiện như
java.lang.String (trừ khi bạn liên kết đến bộ tài liệu thích hợp bằng cách sử dụng liên kết)
bởi vì nó không phải là một phần của bộ tài liệu. Bạn có thể chỉ định -qualifier
java.lang để hiển thị các tham chiếu giống như Chuỗi.

Lưu ý rằng đối với tất cả các tên lớp không đủ tiêu chuẩn, một chú giải công cụ được cung cấp khi bạn đặt
con trỏ chuột lên nó trong tài liệu HTML.

-qualifier tất cả các
Bỏ qua bộ định danh tên gói khỏi tất cả các tên lớp.

Chỉ định tùy chọn này để bỏ qua hoàn toàn các định nghĩa tên gói,

Chọn cái nào Thông tin đến Tạo ra

-công cộng
Chỉ bao gồm các thành viên công khai của các lớp công khai trong đầu ra. Theo mặc định, được bảo vệ
các thành viên trong lớp cũng được bao gồm.

-được bảo vệ
Bao gồm các thành viên công khai hoặc được bảo vệ của các lớp công khai trong đầu ra. Đây là
mặc định.

-gói
Bao gồm các thành viên công cộng, được bảo vệ và gói-riêng của công cộng và gói-riêng
các lớp học.

-riêng tư
Bao gồm tất cả các lớp và thành viên trong lớp bất kể cấp độ truy cập của họ.

-splitindex
Tạo một trang chỉ mục cho mỗi chữ cái thay vì một trang chỉ mục đơn lẻ.

Theo mặc định, chỉ mục được tạo bởi Tài liệu chuẩn chứa tất cả các mục nhập trên một
trang. Điều này là tốt cho các bộ tài liệu nhỏ, nhưng đối với các bộ lớn, bạn nên
chỉ định tùy chọn này.

-nó
Bỏ qua @từ thẻ trong bình luận javadoc.

Theo mặc định, đầu ra được tạo chứa các phần liệt kê phiên bản API của bạn
vì gói, lớp hoặc thành viên lớp được đề cập tồn tại khi thẻ này
đã gặp. Chỉ định tùy chọn này để bỏ qua thông tin này.

-không đồng ý
Không tạo bất kỳ trang cây nào.

Theo mặc định, đầu ra được tạo bao gồm một cây kế thừa cho mỗi gói và - nếu
bộ tài liệu bao gồm nhiều gói - một trang có sự kế thừa đầy đủ
cây. Chỉ định tùy chọn này để bỏ qua việc tạo các trang này.

-noindex
Không xuất chỉ mục theo thứ tự bảng chữ cái.

Theo mặc định, gjdoc tạo một chỉ mục theo thứ tự bảng chữ cái của tất cả các phần tử chương trình trong
bộ tài liệu (gói, lớp, lớp bên trong, hàm tạo, phương thức và
lĩnh vực). Chỉ định tùy chọn này để bỏ qua thông tin này.

-không giúp đỡ
Không tạo trang trợ giúp.

Tùy chọn này hiện bị bỏ qua vì Tài liệu chuẩn không cung cấp trang trợ giúp.

-không được tán thành
Không xuất thông tin nội tuyến về các gói, lớp hoặc thành viên lớp không dùng nữa.

Theo mặc định, Tài liệu chuẩn thêm một đoạn được đánh dấu không còn được dùng nữa
thông tin về mô tả của từng phần tử chương trình không dùng nữa. Chỉ định điều này
tùy chọn để bỏ qua thông tin này.

-nodeprecatedlist
Không xuất trang tóm tắt cho các phần tử API không dùng nữa.

Theo mặc định, Standard Doclet tạo một trang liệt kê tất cả các phần tử API không dùng nữa
cùng với mô tả không dùng nữa, thường bao gồm lý do không dùng nữa
và các lựa chọn thay thế khả thi. Chỉ định tùy chọn này để bỏ qua thông tin này.

-thanh điều hướng
Không xuất thanh điều hướng, đầu trang và chân trang.

Theo mặc định, mỗi trang đầu ra được trang bị một thanh điều hướng trên cùng (có thể bao gồm
một tiêu đề do người dùng chỉ định) và một thanh điều hướng dưới cùng (có thể bao gồm một người dùng-
chân trang được chỉ định). Chỉ định tùy chọn này để bỏ qua trang trí này.

-miễn bình luận
Bỏ qua tất cả văn bản tài liệu khỏi các tệp đã tạo và chỉ xuất các khai báo và
các mối quan hệ phần tử chương trình.

Tùy chọn này ở đây để tương thích với javadoc. Nếu bạn định giải nén
thông tin về dự án của bạn qua gjdoc, bạn nên cân nhắc sử dụng một Doclet khác
thay vào đó cho mục đích của bạn, chẳng hạn như XmlDoclet. Bạn cũng có thể sử dụng API Doclet
trực tiếp bằng cách triển khai Doclet mới.

-liên kết nguồn
Tạo một trang với mã nguồn được đánh dấu cú pháp cho mỗi lớp. Theo mặc định, điều này
trang không được tạo.

Mã nguồn có thể được truy cập bằng cách nhấp vào nút có nhãn "Nguồn" trong
thanh điều hướng hoặc bằng cách nhấp vào tên của một hàm tạo, trường, phương thức hoặc bên trong
lớp trong phần chi tiết của trang tài liệu lớp.

-sử dụng
Tạo một trang với thông tin tham khảo chéo. Theo mặc định, trang này không
được tạo ra.

Thông tin tham khảo chéo có thể được truy cập bằng cách nhấp vào nút có nhãn
`` Sử dụng '' trong thanh điều hướng.

Trang `` Sử dụng '' liệt kê tất cả các lớp / giao diện trong bộ tài liệu
mở rộng / triển khai lớp (loại) được đề cập; các lĩnh vực của loại; phương pháp hoặc
các hàm tạo chấp nhận một tham số của kiểu; các phương thức trả về kiểu; và
các phương thức hoặc hàm tạo ném kiểu.

-tác giả
Bao gồm thông tin tác giả trong đầu ra.

Khi được chỉ định, thông tin tác giả như được chỉ định bằng cách sử dụng @tác giả tag trong javadoc
nhận xét được đưa vào đầu ra. Theo mặc định, @tác giả các thẻ bị bỏ qua.

-phiên bản
Bao gồm thông tin phiên bản trong đầu ra.

Khi được chỉ định, thông tin phiên bản như được chỉ định bằng cách sử dụng @phiên bản tag trong javadoc
nhận xét được đưa vào đầu ra. Theo mặc định, @phiên bản các thẻ bị bỏ qua.

-giấy phép văn bản
Giả sử rằng nhận xét đầu tiên trong mỗi tệp nguồn chứa văn bản giấy phép và thêm
thông tin giấy phép đến chân trang của mỗi trang lớp được tạo.

Đây là một tùy chọn dành riêng cho gjdoc và không tương thích với Sun javadoc.

Tùy chọn này được thiết kế để sử dụng với các dự án mã nguồn mở và miễn phí, nơi mã nguồn
thường có tiền tố là nhận xét về giấy phép soạn sẵn, khi có lý do pháp lý
để bao gồm giấy phép trong tài liệu.

-docfilessubdirs
Sao chép đệ quy tất cả các tệp trong doc-file thư mục con của mỗi thư mục gói.

Thông thường, chỉ các tệp trong doc-file thư mục con được sao chép mà không giảm dần
một cách đệ quy.

-excludedocfilessubdir tên:tên: ...
Không sao chép một số thư mục trực tiếp dưới doc-file thư mục con khi
giảm dần một cách đệ quy.

Đối số cho tùy chọn này phải là một danh sách tên thư mục được phân tách bằng dấu hai chấm.

Tùy chọn này chỉ có ý nghĩa nếu -docfilessubdirs cũng được chỉ định. Trong trường hợp này, bất kỳ
thư mục con nằm ngay bên dưới doc-file thư mục được bỏ qua nếu được liệt kê.

Tuỳ chỉnh Tài liệu Tag

-tagletpath danh sách đường dẫn
Tìm kiếm danh sách đường dẫn khi tải các lớp Taglet tiếp theo được chỉ định bằng cách sử dụng -taglet.

danh sách đường dẫn phải là một hoặc nhiều đường dẫn đến một thư mục hoặc tệp jar, được phân tách bằng
dấu phân tách đường dẫn của nền tảng (thường là : or ;).

-taglet tên lớp
Đăng ký một Taglet.

tên lớp phải là tên đủ điều kiện của một lớp Java triển khai
com.sun.tools.doclets.Taglet.

Các lớp Taglet sẽ được tải từ classpath được chỉ định bằng cách sử dụng -tagletpath, Từ
classpath được chỉ định bằng cách sử dụng -classpath và từ classpath mặc định.

Xem tài liệu của com.sun.tools.doclets.Taglet để biết thêm thông tin.

Lưu ý rằng đối với các thẻ đơn giản, cũng có -nhãn.

-nhãn thông số thẻ
Đăng ký một Taglet chung.

Định dạng của thông số thẻ phải : : " ".

tên thẻ là tên thẻ cần khớp, không có dấu @ ở đầu.

cờ là một hoặc nhiều ký tự sau đây, trong đó mỗi ký tự chỉ định một
ngữ cảnh mã nguồn trong đó thẻ được nhận dạng.

a tất cả các bối cảnh

c người xây dựng

f các lĩnh vực

m phương pháp

o tổng quan

p gói

t các loại (lớp, giao diện, ngoại lệ, lỗi)

X ký tự đặc biệt tạm thời vô hiệu hóa hoàn toàn Taglet.

đầu đuôi là chuỗi để hiển thị trong tiêu đề của phần dành cho thẻ trong
câu hỏi

Ví dụ: để xác định đối sánh thẻ @cvsid cái này được chấp nhận một cách tổng quan,
gói và loại trang và được gắn nhãn với tiêu đề CVS ID, bạn muốn
chỉ rõ:

-tag cvsid: tpo: "ID CVS"

Giả sử rằng một bình luận javadoc của lớp chứa

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

Sau đó, đầu ra HTML sẽ chứa một cái gì đó như

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

Chạy Nền tảng khác Tài liệu

-docletpath danh sách đường dẫn
Tìm kiếm danh sách đường dẫn khi tải các lớp cho Doclet được chỉ định bằng -doclet.

danh sách đường dẫn phải là một hoặc nhiều đường dẫn đến một thư mục hoặc tệp jar, được phân tách bằng
dấu phân tách đường dẫn của nền tảng (thường là : or ;).

-doclet tên lớp
Chạy doclet được chỉ định thay vì HtmlDoclet chuẩn.

tên lớp phải là tên đủ điều kiện của một lớp có giá trị mặc định công khai
hàm tạo và chứa một phương thức có chữ ký sau:

nhập com.sun.javadoc.RootDoc;
khởi động boolean tĩnh công cộng (RootDoc ​​gốc)

Các lớp Doclet sẽ được tải từ classpath được chỉ định bằng cách sử dụng -docletpath, Từ
classpath được chỉ định bằng cách sử dụng -classpath và từ classpath mặc định.

Sản phẩm Bắt đầu phương pháp sẽ xử lý thông tin được hiển thị bởi API Doclet qua rootDoc
và quay lại đúng về thành công, sai về thất bại.

Nếu bạn đang sử dụng tài liệu của bên thứ ba, hãy tham khảo tài liệu của tài liệu đó để biết thêm
hướng dẫn. Lưu ý rằng hỗ trợ cho doclets của bên thứ ba là thử nghiệm. Vui lòng
báo cáo bất kỳ sự cố nào bạn gặp phải hoặc cung cấp phản hồi khi chạy thành công
ứng dụng của bên thứ ba.

Tùy chọn này có thể được chỉ định nhiều lần, trong trường hợp đó tất cả các dấu gạch ngang đều được thực thi
với cùng một cây thông tin được hiển thị qua API Doclet cho mỗi lần chạy Doclet.

Thêm Thông tin đến các Đầu ra

-tiêu đề cửa sổ văn bản
Sử dụng văn bản làm tiền tố tiêu đề cửa sổ trình duyệt.

Khi được chỉ định, tiêu đề cửa sổ trình duyệt cho mỗi trang sẽ có tiền tố là văn bản
thay vì chuỗi mặc định Tạo API Tài liệu.

văn bản phải là văn bản thuần túy (nó không được chứa các thẻ HTML).

-tiêu đề văn bản
Đặt văn bản tiêu đề của trang tổng quan thành văn bản.

văn bản phải là một chuỗi văn bản thuần túy ngắn.

Khi tạo tài liệu cho một gói duy nhất, việc chỉ định tùy chọn này buộc
tạo trang tổng quan.

-cái đầu văn bản html
Thêm văn bản html ở góc trên bên phải của mọi trang được tạo. văn bản html thường là
đặt thành tên của dự án được lập thành tài liệu.

-chân trang văn bản html
Thêm văn bản html ở góc dưới cùng bên phải của mọi trang đã tạo. văn bản html thường
đặt thành giá trị tương tự như cho -cái đầu.

-đáy văn bản html
Thêm văn bản html ở cuối mỗi trang đã tạo, kéo dài toàn bộ chiều rộng của
trang. Khi được chỉ định, văn bản html thường bao gồm một thông báo bản quyền và / hoặc
liên kết đến các trang dự án khác.

-thêm biểu định kiểu hồ sơ
Tăng cường các biểu định kiểu CSS mặc định với biểu định kiểu do người dùng chỉ định hồ sơ.

Biểu định kiểu đã cho chỉ được tải bởi mỗi trang HTML ngoài trang mặc định
những cái, như là biểu định kiểu cuối cùng.

Lưu ý rằng áp dụng quy tắc xếp tầng CSS. Đó là, thuộc tính kiểu của bạn sẽ chỉ là
được chỉ định nếu họ có thứ tự xếp tầng cao hơn gjdoccủa phong cách mặc định. Một đơn giản
cách để đảm bảo rằng đây là trường hợp là khai báo ghi đè của bạn ! important.

Nhìn thấyhttp://www.w3.org/TR/REC-CSS2/cascade.html# cascading-order>.

-nhóm phần mở đầu ký tự đại diện pkg:ký tự đại diện pkg: ...
Sắp xếp các gói đã cho trong một nhóm riêng biệt trên trang tổng quan.

Đối số đầu tiên phải là một văn bản thuần túy ngắn được sử dụng làm tiêu đề của
nhóm gói. Đối số thứ hai phải là một danh sách gói được phân tách bằng dấu hai chấm
ký tự đại diện. Nhóm sẽ bao gồm tất cả các gói trong tập tài liệu có tên
khớp với bất kỳ ký tự đại diện nào đã cho.

Chỉ có một ký tự đại diện, *, khớp với cả hai chữ cái trong tên gói
các thành phần và . tách các thành phần tên gói. Ví dụ, j * regex sẽ
gói phù hợp java.util.regex. Một ví dụ hữu ích hơn sẽ là javax.swing * để phù hợp với
javax.swing và tất cả các gói con của nó.

Tùy chọn này có thể được đưa ra nhiều lần.

Khắc phục sự cố: Thông tin về tổ hợp nhóm tại đây.

gjdoc -group "Core Classes" 'java *' \
-nhóm "Swing" 'javax.swing *' \
-nhóm "API XML" 'javax.xml *' \
-nhóm "Tiện ích mở rộng Khác" javax * \
hữu ích. Cảm ơn !

-Tổng quat hồ sơ
Thêm phân đoạn nội dung XHTML từ hồ sơ đến trang tổng quan.

hồ sơ phải chứa một phân đoạn XHTML với HTML thân hình làm nút gốc.

Tùy chọn này có thể được sử dụng để cung cấp mô tả về tổng thể bộ tài liệu.

Khi được chỉ định, câu đầu tiên của đoạn sẽ được đặt phía trên các bảng
liệt kê các gói được tài liệu hóa, cùng với một liên kết đến bản sao đầy đủ của phân đoạn
được đặt bên dưới các bảng.

Khi tạo tài liệu cho một gói duy nhất, việc chỉ định tùy chọn này buộc
tạo trang tổng quan.

-tệp biểu định kiểu hồ sơ
Sử dụng biểu định kiểu CSS trong hồ sơ thay vì các bảng định kiểu CSS mặc định.

Nếu bạn chỉ muốn ghi đè các phần của biểu định kiểu mặc định, hãy sử dụng -thêm biểu định kiểu
thay thế.

-chức vụ văn bản
Không được chấp nhận. Sử dụng -tiêu đề văn bản thay thế.

-tệp trợ giúp hồ sơ
Tùy chọn này hiện đang bị bỏ qua.

Khi được triển khai, nó sẽ sử dụng đoạn XHTML trong hồ sơ cho nội dung trang trợ giúp
thay vì văn bản trợ giúp mặc định.

Kiểm soát các Đầu ra.

-d thư mục
Đặt tất cả các tệp đầu ra vào thư mục (và các thư mục con). thư mục sẽ được tạo ra
nếu nó không tồn tại, bao gồm tất cả các thư mục mẹ không tồn tại và tất cả các
các thư mục con.

Nếu không được chỉ định, đầu ra sẽ được đặt vào thư mục hiện tại.

-địa phương tên
Sử dụng ngôn ngữ tên thay vì ngôn ngữ mặc định cho tất cả các mục đích.

tên phải là một định nghĩa ngôn ngữ trong biểu mẫu ll_CC [_VAR] Ở đâu ll là chữ thường hai-
mã ngôn ngữ chữ cái ISO-639, CC là một quốc gia ISO-3166 gồm hai chữ cái viết hoa tùy chọn
mã, và VAR là một mã biến thể tùy chọn. Ví dụ, en chỉ định tiếng Anh, en_US
chỉ định tiếng Anh Mỹ và vi_US_WIN chỉ định một biến thể sai lệch của tiếng Anh Mỹ
địa phương.

Lưu ý rằng ngữ nghĩa của tùy chọn này tương ứng chính xác với ngữ nghĩa của các hàm tạo
Của Lớp java.util.Locale.

Tùy chọn này hiện chỉ xác định Bộ ghép ảnh nào đang được sử dụng để sắp xếp đầu ra
các yếu tố. Điều này có nghĩa là ngôn ngữ sẽ chỉ có hiệu lực khi bạn đang sử dụng
Ký tự ASCII trong mã định danh.

-bộ ký tự bảng chữ cái
Không được chấp nhận. Ghi đè mã hóa được chỉ định trong các tệp XHTML đầu ra bằng mã hóa đã cho
by bảng chữ cái.

Nếu tùy chọn này không được cung cấp, đặc điểm kỹ thuật mã hóa trong XHTML đầu ra được chọn để
khớp với mã hóa được sử dụng khi ghi tệp (mã hóa được cung cấp với -mã hóa tài liệu,
hoặc mã hóa mặc định của nền tảng của bạn).

Ngữ nghĩa của bảng chữ cái được chỉ định ở đây:
<http://www.w3.org/TR/2000/REC-xml-20001006# NT-EncName>. Cho tất cả mục đích thiết thực,
chúng giống hệt với các tùy chọn khác chấp nhận tham số bộ ký tự.

Tùy chọn này ở đây để tương thích với javadoc và nên tránh.

-mã hóa tài liệu bảng chữ cái
Sử dụng mã hóa bộ ký tự đã cho khi viết các tệp đầu ra thay vì nền tảng của bạn
mã hóa mặc định.

Ví dụ cho bảng chữ cái đang US-ASCII, ISO-8859-1 or UTF-8.

Ngữ nghĩa của tùy chọn này tương ứng chính xác với ngữ nghĩa của các hàm tạo của lớp
java.util.Locale.

-validhtml
Buộc tạo mã XHTML hợp lệ. Điều này phá vỡ khả năng tương thích với truyền thống
Công cụ Javadoc ở một mức độ nào đó.

Nếu tùy chọn này được chỉ định, các tên liên kết sẽ được thay đổi để chúng hợp lệ
theo đặc điểm kỹ thuật XHTML 1.1. Tuy nhiên, một bộ tài liệu được tạo với
Không thể liên kết tùy chọn này để sử dụng đúng công cụ Javadoc truyền thống. Nó có thể
Tuy nhiên, được liên kết với chỉ tốt bằng cách sử dụng Gjdoc.

Nếu không có tùy chọn này, các tên liên kết cho các thành viên lớp thực thi sẽ sử dụng
định dạng, ví dụ: "foo (String, int [])". Điều này tương thích với truyền thống
Công cụ Javadoc, nhưng theo cả thông số kỹ thuật HTML 4.0 và XHTML 1.0 và 1.1,
định dạng này bao gồm các ký tự bất hợp pháp. Dấu ngoặc đơn, dấu ngoặc vuông và dấu phẩy
không được phép trong tên liên kết.

-baseurl url
Cố định một URL trang liên quan đến url vào mỗi trang được tạo.

Nếu bạn đang tạo tài liệu sẽ chỉ có sẵn tại một
URL, bạn nên sử dụng tùy chọn này để chỉ định URL này.

Điều này có thể giúp tránh các cuộc tấn công chuyển hướng nhất định được sử dụng bởi những người gửi thư rác và nó có thể hữu ích
cho một số ứng dụng web nhất định.

Độ dài Các lựa chọn

-Yên lặng
Chặn tất cả đầu ra ngoại trừ các cảnh báo và thông báo lỗi.

-bèo thuyền
Hãy thật dài dòng về những gì gjdoc đang làm

Tùy chọn này hiện đang bị bỏ qua.

ảo Các lựa chọn

Của mặt trời javadoc công cụ dường như dựa trên tiếng Java và như vậy, nó dường như hoạt động trên máy ảo
cấp độ. gjdoc, ngược lại, là một ứng dụng Java thuần túy.

Vì vậy, gjdoc chỉ có thể giả mạo hoặc mô phỏng các tùy chọn cấp máy ảo sau đây.

-classpath danh sách đường dẫn
Đặt Máy ảo đường dẫn lớp đến danh sách đường dẫn.

Trong hầu hết các trường hợp, bạn nên sử dụng -docletpath or -tagletpath thay vì tùy chọn này.

danh sách đường dẫn phải là một hoặc nhiều đường dẫn đến một thư mục hoặc tệp jar, được phân tách bằng
dấu phân tách đường dẫn của nền tảng (thường là : or ;).

Nếu tùy chọn này không bị chặn ở cấp trình bao bọc, gjdoc hiện đang làm giả nó bởi
gọi System.setProperty ("java.class.path", danh sách đường dẫn); và xuất ra một cảnh báo.

-bootclasspath danh sách đường dẫn
Đặt Máy ảo đường dẫn khởi động đến danh sách đường dẫn.

Nếu tùy chọn này không bị chặn ở cấp trình bao bọc, gjdoc xuất ra một cảnh báo.

-Jvmopt
Chuyển một tham số tùy ý cho Máy ảo gjdoc chạy trên.

Nếu tùy chọn này không bị chặn ở cấp trình bao bọc, gjdoc cố gắng thi đua
tùy chọn và xuất ra một cảnh báo.

Hiện tại, chỉ có tùy chọn VM -D để thiết lập các thuộc tính hệ thống được mô phỏng.

Sử dụng gjdoc-4.8 trực tuyến bằng các dịch vụ onworks.net