ldoc - Online în cloud

PROGRAM:

NUME

ldoc - Un sistem de generare a documentației compatibil LuaDoc

DESCRIERE

LDoc, un generator de documentație pentru Lua compatibil cu LuaDoc.

OPŢIUNI

-d, --dir
directorul de ieșire (documente implicite).

-o, --ieșire
(„index” implicit) nume de ieșire

-v, --verbos
fi verborizat în timpul generării documentului

-A, --toate
afișează funcții locale etc., în documente

-q, --Liniște
suprima ieșirea

-m, --modul
documentele modulului ca text

-da, --stil
Director (implicit!) pentru foaia de stil (ldoc.css)

-l, --șablon
Director (implicit!) pentru șablon (ldoc.ltp)

-p, --proiect
(ldoc implicit) numele proiectului

-t, --titlu
(de referință implicit) titlul paginii

-f, --format
formatare (implicit simplu), opțiunile valide sunt reducere, reducere sau simplă

-b, --pachet
(implicit .) nume de bază pachet de nivel superior (necesar pentru modul(...))

-X, --ext
(HTML implicit) extensia fișierului de ieșire

-c, --config
(implicit config.ld) nume de configurare

-eu, --ignora
ignorați orice avertismente „fără comentariu document sau fără modul”.

-X, --not_luadoc
întrerupe compatibilitatea LuaDoc. Descrierile pot continua după etichete.

-D, --defini
(implicit niciunul) setați un flag pentru a fi utilizat în config.ld

-C, --colon
utilizați stilul două puncte

-B, --boilerplate
ignora primul comentariu din fișierele sursă

-M, --combina
permite îmbinarea modulelor

-S, --simplu
fără returnare sau parametri, fără rezumat

-O, --unu
aspect de ieșire pe o singură coloană

--descărcare depanare dump de ieșire

--filtru
(implicit niciunul) ieșire de filtru ca date Lua (de ex. pl.pretty.dump)

--Etichete (implicit niciunul) arată toate referințele la etichetele date, separate prin virgulă

(șir) fișier sursă sau director care conține sursa

EXEMPLE

ldoc . citește opțiuni dintr-un fișier config.ld din același director

ldoc -c cale/la/myconfig.ld .
citește opțiunile din calea/la/myconfig.ld

Utilizați ldoc online folosind serviciile onworks.net