haddock - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

haddock - công cụ tài liệu cho mã nguồn Haskell có chú thích

SYNOPSIS

giống cá vược mà nhỏ [lựa chọn] hồ sơhữu ích. Cảm ơn !

MÔ TẢ

Trang hướng dẫn sử dụng này tài liệu ngắn gọn về giống cá vược mà nhỏ chỉ huy. Tài liệu mở rộng là
có sẵn ở nhiều định dạng khác nhau bao gồm DVI, PostScript và HTML; xem bên dưới.

hồ sơ là tên tệp chứa mô-đun nguồn Haskell. Tất cả các mô-đun được chỉ định trên
dòng lệnh sẽ được xử lý cùng nhau. Khi một mô-đun đề cập đến một thực thể trong một mô-đun khác
mô-đun đang được xử lý, tài liệu sẽ liên kết trực tiếp đến thực thể đó.

Các thực thể không thể được tìm thấy, chẳng hạn như vì chúng nằm trong một mô-đun không được
được xử lý như một phần của lô hiện tại, đơn giản là sẽ không được siêu liên kết trong
tài liệu hướng dẫn. giống cá vược mà nhỏ sẽ phát ra cảnh báo liệt kê tất cả các số nhận dạng mà nó không thể
giải quyết.

Các mô-đun không được đệ quy lẫn nhau, vì giống cá vược mà nhỏ không thích bơi
vòng tròn.

LỰA CHỌN

Các chương trình tuân theo cú pháp dòng lệnh GNU thông thường, với các tùy chọn dài bắt đầu bằng hai
dấu gạch ngang (`- '). Dưới đây là một bản tóm tắt các tùy chọn. Để có một mô tả đầy đủ, hãy xem
các tài liệu khác.

-o DIR, --odir =DIR
thư mục để đặt các tệp đầu ra

-i FILE, --read-interface =FILE
đọc một giao diện từ FILE.

-D FILE, --dump-interface =FILE
kết xuất giao diện cho các mô-đun này trong FILE.

-l DIR, --lib =DIR
vị trí của các tệp phụ trợ của Haddock

-h, --html
Tạo tài liệu ở định dạng HTML. Một số tệp sẽ được tạo vào
thư mục hiện tại (hoặc thư mục được chỉ định nếu -o tùy chọn được đưa ra), bao gồm
sau đây:

index.html
Trang cấp cao nhất của tài liệu: liệt kê các mô-đun có sẵn, sử dụng
thụt lề để đại diện cho hệ thống phân cấp nếu các mô-đun là thứ bậc.

cá tuyết.css
Biểu định kiểu được HTML tạo sử dụng. Vui lòng sửa đổi điều này thành
thay đổi màu sắc hoặc bố cục hoặc thậm chí chỉ định biểu định kiểu của riêng bạn bằng cách sử dụng
--css tùy chọn.

mô-đun.html
Một trang HTML cho mỗi mô-đun.

doc-index.html, doc-index-XX.html
Chỉ mục, được chia thành hai (hàm / hàm tạo và kiểu / lớp, theo
Không gian tên Haskell) và tiếp tục phân chia theo thứ tự bảng chữ cái.

--hoogle
đầu ra cho Hoogle

--html-help =định dạng
tạo chỉ mục và mục lục ở định dạng mshelp, mshelp2 hoặc devhelp (với -h)

--source-base =URL
Bao gồm các liên kết đến các tệp nguồn trong tài liệu đã tạo, trong đó URL là
URL cơ sở nơi có thể tìm thấy các tệp nguồn.

-s url, --source-module =URL
Bao gồm các liên kết đến các tệp nguồn trong tài liệu đã tạo, trong đó URL là
liên kết mã nguồn cho từng mô-đun (sử dụng các vars% {FILE} hoặc% {MODULE}).

--source-entity =URL
Bao gồm các liên kết đến các tệp nguồn trong tài liệu đã tạo, trong đó URL là
liên kết mã nguồn cho từng thực thể (sử dụng các vars% {FILE},% {MODULE} hoặc% {NAME}).

--comments-base =URL
URL cho một liên kết nhận xét trên nội dung và các trang chỉ mục.

--comments-module =URL
URL cho liên kết nhận xét cho từng mô-đun (sử dụng var% {MODULE}).

--comments-entity =URL
URL cho liên kết nhận xét cho từng thực thể (sử dụng% {FILE},% {MODULE} hoặc% {NAME}
bình).

--css =FILE
Sử dụng CSS FILE thay vì biểu định kiểu mặc định đi kèm với giống cá vược mà nhỏ cho HTML
đầu ra. Nó phải chỉ định các lớp nhất định: xem biểu định kiểu mặc định để biết chi tiết.

-p FILE, --prologue =FILE
Chỉ định một tệp chứa văn bản mở đầu.

-t TITLE, --title =TITLE
Sử dụng TITLE làm tiêu đề trang cho mỗi trang trong tài liệu. Điều này sẽ
thường là tên của thư viện được lập thành tài liệu.

Tiêu đề phải là một chuỗi đơn giản (vui lòng không đánh dấu!).

-k TÊN, --package =TÊN
Chỉ định tên gói (tùy chọn).

-n, --no-ẩn-khởi đầu
đừng cho rằng Prelude được nhập

-d, --gỡ lỗi
Bật đầu ra gỡ lỗi bổ sung.

-?, --Cứu giúp
Hiển thị trợ giúp.

-V, --phiên bản
Phiên bản hiển thị.

-v, --dài dòng
Báo cáo tình trạng chi tiết.

--use-content =URL
Sử dụng trang nội dung HTML được tạo riêng.

--gen-nội dung
Tạo nội dung HTML từ các giao diện được chỉ định.

--use-index =URL
Sử dụng chỉ mục HTML được tạo riêng.

--gen-index
Tạo chỉ mục HTML từ các giao diện được chỉ định.

--ignore-all-export
Cư xử như thể tất cả các mô-đun đều có thuộc tính bỏ qua xuất

--hide =MODULE
Cư xử như thể MODULE có thuộc tính ẩn.

--use-package =GÓI
Các mô-đun đang được xử lý phụ thuộc vào GÓI.

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