ldoc - Dalam talian dalam Awan

JADUAL:

NAMA

ldoc - Sistem penjanaan dokumentasi yang serasi dengan LuaDoc

DESCRIPTION

LDoc, penjana dokumentasi untuk Lua yang serasi dengan LuaDoc.

PILIHAN

-d, --dir
(dokumen lalai) direktori output

-o, --pengeluaran
(default 'indeks') nama output

-v, --verbose
menjadi verbose semasa penjanaan dokumen

-A, --semua
tunjukkan fungsi setempat, dsb, dalam dokumen

-q, --senyap
menekan output

-m, --modul
dokumen modul sebagai teks

-ya, --gaya
(lalai!) direktori untuk helaian gaya (ldoc.css)

-l, --template
(lalai!) direktori untuk templat (ldoc.ltp)

-p, --projek
(default ldoc) nama projek

-t, --tajuk
(Rujukan lalai) tajuk halaman

-f, --format
pemformatan (biasa lalai), pilihan yang sah ialah penurunan nilai, diskaun atau biasa

-b, --pakej
(default .) nama asas pakej peringkat atas (diperlukan untuk modul(...))

-x, --samb
(html lalai) sambungan fail output

-c, --config
(default config.ld) nama konfigurasi

-saya, --abai
abaikan sebarang amaran 'tiada komen dokumen atau tiada modul'

-X, --bukan_luadoc
memecahkan keserasian LuaDoc. Penerangan boleh diteruskan selepas tag.

-D, --takrifkan
(tiada lalai) tetapkan bendera untuk digunakan dalam config.ld

-C, --kolon
gunakan gaya kolon

-B, --boilerplate
abaikan ulasan pertama dalam fail sumber

-M, --bercantum
membenarkan penggabungan modul

-S, --mudah
tiada pulangan atau params, tiada ringkasan

-O, --satu
susun atur keluaran satu lajur

--pembuangan dump output nyahpepijat

--penapis
(tiada lalai) keluaran penapis sebagai data Lua (cth pl.pretty.dump)

--tag (tiada lalai) tunjukkan semua rujukan kepada teg yang diberikan, dipisahkan koma

(rentetan) fail sumber atau direktori yang mengandungi sumber

CONTOH

ldoc . membaca pilihan daripada fail config.ld dalam direktori yang sama

ldoc -c path/to/myconfig.ld .
membaca pilihan dari path/to/myconfig.ld

Gunakan ldoc dalam talian menggunakan perkhidmatan onworks.net