makekel-3.0.0 - Online w chmurze

PROGRAM:

IMIĘ

makekel - wygeneruj plik opisu dla fpdoc.

STRESZCZENIE

makekel [--descr=nazwa pliku] [--disable-arguments] [--disable-errors] [--disable-function-
wyniki] [--disable-private] [--disable-protected] [--disable-seealso] [--emit-class-
separator] [--help] [--lang=język] [--output=nazwa pliku] [--update] --package=nazwa
--input=linia cmd

Opis

makekel skanuje plik źródłowy jednostki Free Pascal i generuje plik opisu szkieletu
dla tego. Generuje węzły dla wszystkich identyfikatorów znajdujących się w części interfejsu urządzenia,
chociaż to zachowanie można dostosować za pomocą niektórych opcji. Może także zaktualizować istniejący
XML, a następnie emituje tylko węzły dla identyfikatorów, dla których żaden węzeł jeszcze nie istnieje.

Stosowanie

Możesz się przywołać makekel z jedynymi wymaganymi argumentami wkład i pakiet
argumenty. Powinien zawierać co najmniej nazwę pliku jednostkowego, dla którego dokumentacja
powinien zostać wygenerowany oraz nazwę pakietu, do którego należy jednostka. Wyjście
makekel domyślnie przejdzie na standardowe wyjście.

Opcje

makekel ma wiele opcji, większość z nich jest opcjonalna, w większości przypadków zostaną użyte ustawienia domyślne.

--descr=plikdesc
Opcji tej należy używać w połączeniu z aktualizacja opcja. Określa
nazwa pliku opisu plik desc które należy zaktualizować. Pamiętaj, że plik musi
zawierać prawidłowy kod XML, w przeciwnym razie aktualizacja zakończy się niepowodzeniem. Tę opcję można określić więcej niż
pewnego razu.

--wyłącz-argumenty
Jeśli ta opcja jest określona, makekel nie będzie emitować węzłów dla argumentów
funkcje i procedury. Domyślnie węzły dokumentacji są emitowane dla funkcji
i procedury także.

--wyłącz-błędy
Domyślnie każdy węzeł dokumentacji będzie zawierał plik błędy węzeł również (z wyjątkiem
identyfikatory tam, gdzie nie ma to żadnego zastosowania, np. argumenty funkcji). Jeśli jest taka opcja
określone, nie błędy węzeł zostanie wygenerowany.

--wyłącz wyniki funkcji
Domyślnie dla funkcji a dalsze zostanie wygenerowany węzeł, aby opisać wynik
funkcji. Jeżeli określono tę opcję, nie będzie żadnego węzła wynikowego funkcji
wygenerowane.

--wyłącz-prywatny
Domyślnie węzły dokumentacji są generowane także dla prywatnych pól lub metod
Klasa. jeśli ta opcja jest określona, ​​generowanie węzłów dla pól prywatnych lub
metody są pomijane.

--wyłącz-zabezpieczone
Domyślnie węzły dokumentacji są generowane również dla chronionych pól lub metod
z klasy. jeśli ta opcja jest określona, ​​generowanie węzłów dla chronionych
pola lub metody są pomijane.

--emit-separator-klas
Jeśli ta opcja jest zaznaczona, widoczny jest komentarz z nazwą klasy, dla której
węzły dokumentacji zostaną wstawione pomiędzy węzłami dwóch klas,
ułatwiając nawigację.

--help Wyślij krótki tekst pomocy i zakończ.

--wejście=cmd
Plik wejściowy (źródłowy) do przetworzenia. Można określić wiele plików wejściowych. The
polecenie może zawierać prawidłowe opcje kompilatora, obecnie -Fipath (ścieżka wyszukiwania) i
-dmakro (definiuj makro) opcje są rozpoznawane.

--lang=język
Ustawia język pliku wyjściowego. To głównie ustawi struny używane do
nagłówki w różnych częściach plików dokumentacji (domyślnie są w
język angielski). Obecnie prawidłowe opcje to

de niemiecku.

fr Francuski.

nl holenderski

--output=nazwa pliku
Ta opcja mówi makekel gdzie powinny iść dane wyjściowe. Jeśli ta opcja nie jest
określone, wyjście jest wysyłane na standardowe wyjście (ekran).

--package=nazwapakietu
Ta opcja jest wymagana. Określa nazwę pakietu. Wszystkie węzły będą
generowane wewnątrz węzła za pomocą Nazwa atrybut nazwapakietu.

--aktualizacja
Włącza tryb aktualizacji. W tym trybie wyjściem jest plik zawierający tylko plik
brakujące węzły w celu uzupełnienia dokumentacji plików wejściowych. Istniejące węzły
należy określić za pomocą opis argument. Należy pamiętać, że plik wyjściowy może nie być
takie same jak węzły wejściowe (opisowe); Należy określić oddzielny plik (lub nie
plik, w którym to przypadku wyjście przechodzi na standardowe wyjście.

Korzystaj z makekel-3.0.0 online, korzystając z usług onworks.net