ldoc - Online in de cloud

PROGRAMMA:

NAAM

ldoc - Een LuaDoc-compatibel systeem voor het genereren van documentatie

PRODUCTBESCHRIJVING

LDoc, een documentatiegenerator voor Lua die compatibel is met LuaDoc.

OPTIES

-NS, -- richt
(standaard docs) uitvoermap

-O, --uitvoer
(standaard 'index') uitvoernaam

-in, --uitgebreid
wees uitgebreid tijdens het genereren van documenten

-een, --alle
toon lokale functies, enz., in documenten

-Q, --stil
output onderdrukken

-M, --module
moduledocumenten als tekst

-Ja, --stijl
(standaard!) directory voor stijlblad (ldoc.css)

-ik, --sjabloon
(standaard!) map voor sjabloon (ldoc.ltp)

-P, --project
(standaard ldoc) projectnaam

-T, --titel
(standaard referentie) paginatitel

-F, --formaat
(standaard gewone) opmaak, geldige opties zijn prijsverlaging, korting of gewone

-B, --pakket
(standaard .) basisnaam van pakket op het hoogste niveau (vereist voor module(...))

-X, --ext
(standaard html) uitvoerbestandsextensie

-C, --config
(standaard config.ld) configuratienaam

-l, --negeren
negeer eventuele 'geen doc commentaar of geen module' waarschuwingen

-X, --niet_luadoc
verbreek de LuaDoc-compatibiliteit. Beschrijvingen kunnen doorgaan na tags.

-NS, --definiëren
(standaard geen) stel een vlag in die moet worden gebruikt in config.ld

-C, --dubbele punt
gebruik dubbele puntstijl

-B, --standaard
negeer de eerste opmerking in bronbestanden

-M, --samenvoegen
module samenvoegen toestaan

-S, --eenvoudig
geen terugkeer of params, geen samenvatting

-O, --een
uitvoerlay-out met één kolom

--dumpen uitvoerdump debuggen

--filter
(standaard geen) filteruitvoer als Lua-gegevens (bijv. pl.pretty.dump)

--labels (standaard geen) toont alle verwijzingen naar bepaalde tags, gescheiden door komma's

(tekenreeks) bronbestand of map met bron

Voorbeelden

ldoc . leest opties uit een bestand config.ld in dezelfde directory

ldoc -c pad/naar/myconfig.ld .
leest opties van pad/naar/myconfig.ld

Gebruik ldoc online met behulp van onworks.net-services