Jest to polecenie ldoc, które można uruchomić u dostawcy bezpłatnego hostingu OnWorks przy użyciu jednej z naszych wielu bezpłatnych stacji roboczych online, takich jak Ubuntu Online, Fedora Online, emulator online systemu Windows lub emulator online systemu MAC OS
PROGRAM:
IMIĘ
ldoc - System generowania dokumentacji zgodny z LuaDoc
OPIS
LDoc, generator dokumentacji dla Lua kompatybilny z LuaDoc.
OPCJE
-D, --reż
(domyślny katalog wyjściowy dokumentów).
-o, --wyjście
(domyślnie „indeks”) nazwa wyjściowa
-v, --gadatliwy
być szczegółowy podczas generowania dokumentu
-za, --wszystko
pokaż funkcje lokalne itp. w dokumentach
-Q, --cichy
tłumić wyjście
-M, --moduł
dokumentacja modułu jako tekst
-tak, --styl
(domyślny!) katalog arkusza stylów (ldoc.css)
-ja, --szablon
(domyślny!) katalog szablonu (ldoc.ltp)
-P, --projekt
(domyślna nazwa projektu ldoc).
-T, --tytuł
(domyślny odnośnik) tytuł strony
-F, --format
(domyślne zwykłe) formatowanie, prawidłowe opcje to przecena, rabat lub zwykły
-B, --pakiet
(domyślnie .) nazwa podstawowa pakietu najwyższego poziomu (potrzebna do moduł(...))
-X, --wewn
(domyślne html) rozszerzenie pliku wyjściowego
-C, --konfig
(domyślna config.ld) nazwa konfiguracji
-ja, --ignorować
zignoruj wszelkie ostrzeżenia „brak komentarza do dokumentu lub brak modułu”.
-X, --not_luadoc
przerwać kompatybilność LuaDoc. Opisy mogą być kontynuowane po tagach.
-D, --definiować
(domyślnie brak) ustawia flagę, która będzie używana w config.ld
-DO, --okrężnica
użyj stylu dwukropka
-B, --płyta kotłowa
zignoruj pierwszy komentarz w plikach źródłowych
-M, --łączyć
zezwolić na scalanie modułów
-S, --prosty
bez zwrotu i parametrów, bez podsumowania
-O, --jeden
jednokolumnowy układ wyjściowy
--wysypisko debugowanie zrzutu wyjściowego
--filtr
(domyślnie brak) wyjście filtra jako dane Lua (np. pl.pretty.dump)
--tagi (domyślnie brak) pokazuje wszystkie odniesienia do podanych tagów, oddzielone przecinkami
(string) plik źródłowy lub katalog zawierający źródło
PRZYKŁADY
ldoc . odczytuje opcje z pliku config.ld w tym samym katalogu
ldoc -c ścieżka/do/myconfig.ld .
odczytuje opcje z path/to/myconfig.ld
Użyj ldoc online, korzystając z usług onworks.net
