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

CHƯƠNG TRÌNH:

TÊN

ldoc - Hệ thống tạo tài liệu tương thích với LuaDoc

MÔ TẢ

LDoc, một trình tạo tài liệu cho Lua tương thích với LuaDoc.

LỰA CHỌN

-NS, --dir
(tài liệu mặc định) thư mục đầu ra

-ồ, - đầu ra
(mặc định 'chỉ mục') tên đầu ra

-v, --dài dòng
dài dòng trong quá trình tạo tài liệu

-một, --tất cả các
hiển thị các chức năng cục bộ, v.v., trong tài liệu

-NS, --Yên lặng
ngăn chặn đầu ra

-NS, - mô-đun
tài liệu mô-đun dưới dạng văn bản

-S, --Phong cách
(default!) thư mục cho trang định kiểu (ldoc.css)

-l, --bản mẫu
(default!) thư mục cho mẫu (ldoc.ltp)

-P, --dự án
(mặc định ldoc) tên dự án

-NS, --chức vụ
(Tham chiếu mặc định) tiêu đề trang

-NS, --định dạng
định dạng (đơn giản mặc định), các tùy chọn hợp lệ là đánh dấu, giảm giá hoặc đơn giản

-NS, --Bưu kiện
(mặc định.) tên cơ sở gói cấp cao nhất (cần thiết cho mô-đun(...))

-NS, --ext
(html mặc định) phần mở rộng tệp đầu ra

-NS, --config
(default config.ld) tên cấu hình

-tôi, --phớt lờ
bỏ qua mọi cảnh báo 'không có nhận xét tài liệu hoặc không có mô-đun'

-NS, --not_luadoc
phá vỡ khả năng tương thích LuaDoc. Mô tả có thể tiếp tục sau thẻ.

-NS, --định nghĩa
(mặc định không có) đặt cờ được sử dụng trong config.ld

-NS, --Đại tràng
sử dụng kiểu dấu hai chấm

-NS, --bản mẫu
bỏ qua nhận xét đầu tiên trong các tệp nguồn

-NS, - hợp nhất
cho phép hợp nhất mô-đun

-NS, --đơn giản
không trả lại hoặc thông số, không có tóm tắt

-Ồ, --một
bố cục đầu ra một cột

--bãi rác gỡ lỗi kết xuất đầu ra

--lọc
(mặc định không có) đầu ra bộ lọc dưới dạng dữ liệu Lua (ví dụ: pl.pretty.dump)

--tags (mặc định không có) hiển thị tất cả các tham chiếu đến các thẻ nhất định, được phân tách bằng dấu phẩy

(chuỗi) tệp nguồn hoặc thư mục chứa nguồn

VÍ DỤ

ldoc . đọc các tùy chọn từ tệp config.ld trong cùng một thư mục

ldoc -c path / to / myconfig.ld .
đọc các tùy chọn từ đường dẫn / đến / myconfig.ld

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