autogsdoc - Online w chmurze

PROGRAM:

IMIĘ

autogsdoc - generator dokumentacji API GNUstep i konwerter XML->HTML

STRESZCZENIE

autogdoc [-Akta filename] [-Wygeneruj kod HTML TAK|nie] [-Czysty tak | NIE] [-Wyczyść szablony
tak | NIE] [-Ignoruj ​​zależności tak | NIE] [-Utwórz zależności tak | NIE] [-Pokaż zależności tak | NIE]
[-Katalog nagłówków ścieżka] [-Katalog dokumentacji ścieżka] [-Zdeklarowany lokalizacja] [-Projekt
tytuł] [-Standardy tak | NIE] [-DocumentAllInstanceVariables tak | NIE]
[-Zmienne instancji dokumentu TAK|nie] [-Zmienne instancji na końcu tak | NIE] [-Szablon stałych
filename] [-Szablon funkcji filename] [-Szablon makr filename] [-TypedefsTemplate
filename] [-Szablon zmiennych filename] [-Projekty systemowe ciąg] [-Projekty lokalne ciąg]
[-Projektowanie dyktString] [-Gadatliwy tak | NIE] [-Ostrzegać tak | NIE] [-Mapa słów dyktString] [pliki]

OPIS

Narzędzie autogsdoc to narzędzie wiersza poleceń, które pomaga programistom tworzyć odniesienia
dokumentacja API GNUstep. Umożliwia także programistom pisanie i utrzymywanie innych
dokumentację w formacie XML i zlecić jej konwersję do formatu HTML. Szczegółowo autogsdoc:

- Wyodrębnij specjalne komentarze opisujące publiczne interfejsy klas, kategorii,
protokoły, funkcje i makra z kodu źródłowego Objective C (pliki nagłówkowe i
opcjonalnie pliki źródłowe) do plików XML GSDoc.

- Konwertuj pliki XML GSDoc, niezależnie od tego, czy są wygenerowane z kodu źródłowego, czy zapisane ręcznie
programistów do HTML.

- Konstruuj indeksy w oparciu o zestawy plików XML GSDoc i konwertuj je również na format HTML.

Najczęstszym zastosowaniem jest uruchomienie polecenia z jedną lub większą liczbą nazw plików nagłówkowych jako
argumenty... narzędzie automatycznie przeanalizuje odpowiednie pliki źródłowe w tym samym
katalog jako nagłówki (lub katalog bieżący lub katalog określony za pomocą
DocumentationDirectory) i tworzy pliki GSDoc i HTML jako dane wyjściowe. Dla najlepszego
wyniki tryb ten należy uruchomić z katalogu zawierającego pliki źródłowe. (Notatka
że ponieważ C jest podzbiorem Celu C, narzędzie to może służyć do dokumentowania funkcji i
inne struktury C w zwykłym źródle C.)

Pliki GSDoc mogą być również dostarczane bezpośrednio jako dodatek lub osobno i zostaną skonwertowane
do HTML-a. Zobacz dokumentację HTML GSDoc lub plik gsdoc(7) strona podręcznika zawierająca informacje na temat
formacie GSDoc.

Wreszcie, pliki HTML mogą być podawane w wierszu poleceń. Odsyłacze do innych części
znaleziona w nich dokumentacja kodu zostanie przepisana w oparciu o to, co można znaleźć w pliku
projekt obecnie.

ŹRÓDŁO KOD NARZUT

Parser kodu źródłowego automatycznie utworzy dokumenty GSDoc zawierające listę metod
klasy znalezione w plikach źródłowych i będzie zawierać tekst ze specjalnie sformatowanego formatu
komentarze z plików źródłowych.

Każdy komentarz zaczynający się od ukośnika i drugiej gwiazdki zamiast zwykłego ukośnika i pojedynczego
gwiazdka, jest traktowana jako znacznik GSDoc, używany jako opis klasy lub metody
podążanie za tym. Tekst komentarza jest ponownie formatowany, a następnie wstawiany do danych wyjściowych.
Jeśli z tym samym elementem jest powiązanych wiele komentarzy, są one łączone za pomocą a
przerwanie linii ( ) pomiędzy nimi, jeśli to konieczne.

Narzędzie można łatwo wykorzystać do dokumentowania programów i bibliotek, po prostu je udostępniając
nazwa pliku źródłowego zawierającego funkcję main() programu - przyjmuje
specjalne komentarze z tej funkcji i obsługuje je specjalnie, wstawiając je jako a
sekcja na końcu pierwszego rozdziału dokumentu (tworzy pierwszy rozdział if
niezbędny).

Opcje opisano w rozdziale Argumenty i Defaults poniżej.

DODATKOWY NARZUT

W niektórych przypadkach przeprowadza się specjalne dodatkowe przetwarzanie, głównie w
pierwszy komentarz znaleziony w pliku źródłowym, z którego mogą pochodzić różne fragmenty znaczników GSDoc
wyodrębnione i umieszczone w odpowiednich miejscach dokumentu wyjściowego -

Źródło Autogsdoc:
W dowolnej linii gdzie Źródło Autogsdoc: zostanie znaleziony, pozostała część linii zostanie przyjęta jako a
nazwa pliku źródłowego, która ma zostać użyta, zamiast zakładać, że każdy plik .h
przetwarzane używa pliku .m o tej samej nazwie. Możesz podać wiele Źródło Autogsdoc:
linie, w których plik nagłówkowy deklaruje elementy zdefiniowane w wielu plikach źródłowych.
Jeśli nazwa pliku jest bezwzględna, używana jest w takiej postaci, w jakiej została podana. Jeśli natomiast jest to a
ścieżka względna, oprogramowanie szuka najpierw pliku źródłowego w oparciu o lokalizację
pliku nagłówkowego, a jeśli tam nie zostanie znaleziony, w odniesieniu do bieżącego katalogu, w którym
autogsdoc jest uruchomiony i na koniec względem katalogu określonego przez plik
Katalog Dokumentacji domyślna.


Streszczenie treści dokumentu... umieszczone w nagłówku wyjścia GSDoc.


Opis autora kodu - można powtórzyć w przypadku, gdy a
dokument ma wielu autorów. Umieszczony w nagłówku wyjścia GSDoc. Jako pomoc
czytelność źródła, w związku z czym przeprowadzane jest specjalne dodatkowe przetwarzanie
autor dokumentu - Dowolna linia postaci „Autor: imię i nazwisko ', lub przez:
nazwa ', 'Autor: imię' lub 'Przez: imię' zostaną rozpoznane i
przekonwertowany na autor element, prawdopodobnie zawierający E-mail elementem.


Umieszczany w wynikach GSDoc tuż przed końcem treści dokumentu – zamierzony
do wykorzystania w załącznikach, indeksie itp.


Umieszczona bezpośrednio przed jakąkolwiek wygenerowaną dokumentacją klasową... przeznaczoną do wykorzystania
aby zapewnić ogólny opis działania dokumentowanego kodu. Każdy
dokumentacja funkcji main() programu jest wstawiana jako sekcja na końcu
tego rozdziału.


Prawa autorskie do treści dokumentu... umieszczone w nagłówku wyjścia GSDoc.
Aby zwiększyć czytelność źródła, stosuje się specjalne dodatkowe przetwarzanie
wykonane — dowolna linia w formacie „Tekst praw autorskich (C)” zostanie rozpoznana i przekonwertowana
do kopia elementem.


Data rewizji dokumentu... umieszczona w nagłówku wyniku GSDoc. Jeśli
zostało to pominięte, narzędzie spróbuje skonstruować wartość ze znacznika RCS Date (jeśli
dostępny).


W dokumencie umieszcza się na początku treść... z przeznaczeniem na zabezpieczenie
strony ze wstępem lub spisem treści itp.


Tytuł dokumentu... umieszczany w nagłówku wyniku GSDoc. Jeśli to zostanie pominięte
narzędzie wygeneruje własny (prawdopodobnie słaby) tytuł - więc powinieneś go uwzględnić
znaczniki ręcznie.


Identyfikator wersji dokumentu... umieszczony w nagłówku wyniku GSDoc. Jeśli
zostało to pominięte, narzędzie spróbuje skonstruować wartość ze znacznika wersji RCS (jeśli
dostępny).

NB Opisany właśnie znacznik może być używany w dokumentacji klasy, kategorii lub protokołu
... jeśli tak, jest on wyodrębniany i otaczany resztą dokumentacji klasy
jako rozdział zajęć. Pozostała część dokumentacji klasowej jest zwykle wstawiana w
końcu rozdziału, ale zamiast tego można je zastąpić zamiast rzekomy-
element wewnątrz element.

SPOSÓB NARZUT

W komentarzach używanych do podania tekstu opisu metody stosuje się następujący znacznik
usunięte z tekstu i traktowane specjalnie -


Metoda jest oznaczona jako wyznaczony inicjator dla klasy.


Metoda jest oznaczona jako taka, którą podklasy muszą zastąpić (np. streszczenie
metoda).


Metoda jest oznaczona jako taka, jaką powinny mieć podklasy NIE nadpisanie.


Znacznik zostanie usunięty z opisu i umieszczony po to na wyjściu GSDoc -
tak, że metoda jest opisana jako zgodna (lub niezgodna) z określonymi
standardy.

ZAUTOMATYZOWANE NARZUT

Ogólnie rzecz biorąc, tekst komentarzy jest przeformatowany w celu ujednolicenia i odpowiedniego wcięcia…
jest ponowne formatowanie nie wykonywane na dowolnym tekście wewnątrz pliku element. Kiedy jest tekst
przeformatowany, jest dzielony na oddzielone spacjami „słowa”, którym następnie poddaje się
trochę dodatkowej obróbki...

Niektóre dobrze znane stałe, takie jak TAK, NIE i zero, są ujęte w ...
narzut.

Nazwy argumentów metod w opisach metod są ujęte w ...
</ var> znaczniki.

Nazwy metod (zaczynające się od plusa lub minusa) są ujęte w ...
narzut. Np. „-init” (bez cudzysłowów) zostanie opakowany w referencję GSDoc
element wskazujący metodę init bieżącej klasy lub, jeśli jest tylko jedna znana klasa
miał metodę init, odnosiłby się do metody tej klasy. Zwróć uwagę na fakt
nazwa metody musi być otoczona spacjami, aby została rozpoznana (choć przecinkiem,
kropka lub średnik na końcu specyfikatora będą działać jak białe znaki).

Specyfikatory metod, w tym nazwy klas (rozpoczynające się i kończące na nawiasach kwadratowych)
są zawarte w ... narzut. np. „[NSObject-init]”, utworzy plik
odwołanie do metody init NSObject (albo właściwej klasy, albo dowolnej jej
kategorie), natomiast „[(NSCopying)-copyWithZone:]” tworzy odwołanie do metody w
protokół NSCopying. Należy pamiętać, że pomiędzy nawiasami kwadratowymi nie mogą znajdować się spacje
w tych specyfikatorach. Nazwy protokołów są ujęte w nawiasy okrągłe, a nie
zwyczajowe nawiasy kątowe, ponieważ GSDoc jest językiem XML, a XML traktuje kąt
specjalnie nawiasy.

Nazwy funkcji (kończące się na „()”) inne niż „main()” są ujęte w ...
narzut. Np. "NSLogv()" (bez cudzysłowów) zostanie opakowane w plik GSDoc
element referencyjny wskazujący dokumentację funkcji NSLog. Zwróć uwagę na fakt
że nazwa funkcji musi być otoczona białymi znakami (przecinkiem, kropką lub
średnik na końcu specyfikatora będzie również działać jako terminator białych znaków).

ARGUMENTY ROLNICZE DOMYŚLNE

Narzędzie akceptuje pewne ustawienia domyślne użytkownika (które można oczywiście podać w wierszu poleceń
argumenty, dodając „-” przed nazwą domyślną i podając wartość później, jak w przypadku
-Czystość TAK):

Czyszczenie
Jeśli ta wartość logiczna jest ustawiona na TAK, zamiast generować dokumentację, plik
narzędzie usuwa wszystkie pliki GSDoc wygenerowane w projekcie oraz wszystkie wygenerowane pliki HTML
z nich (jak również te, które zostałyby wygenerowane z wymienionych plików GSDoc
jawnie) i ostatecznie usuwa plik indeksu projektu. Jedyny wyjątek od tego
czy są to pliki szablonów GSDoc (tj. te określone za pomocą „-ConstantsTemplate…”),
Argumenty „-FunctionsTemplate…” itp.) nie są usuwane, chyba że plik CleanTemplates
flaga jest ustawiona.

Wyczyść szablony
Ta flaga określa, czy pliki szablonów GSDoc mają zostać usunięte razem z innymi
plików, jeśli określono opcję Wyczyść. Domyślnie nie są one usuwane
... ponieważ szablony te mogły zostać utworzone ręcznie i po prostu wprowadzono do nich dane
w nich.

Szablon stałych
Określ nazwę dokumentu szablonu, w którym będzie zawarta dokumentacja dotycząca stałych
należy wstawić ze wszystkich plików w projekcie. Jest to przydatne, jeśli stałe w
kod źródłowy jest rozproszony po wielu plikach i należy je zgrupować w jeden
miejsce. Jesteś odpowiedzialny za zapewnienie, że podstawowy dokument szablonowy (w którym
wstawiana jest indywidualna stała dokumentacja) zawiera wszystkie pozostałe informacje
chcesz, ale dla wygody autogsdoc wygeneruje prosty szablon (który możesz
następnie edytuj) dla Ciebie, jeśli plik nie istnieje. Wstawienie następuje natychmiast
przed z powrotem element (lub jeśli taki nie istnieje, bezpośrednio przed końcem
ciało element) w szablonie.

Zdeklarowany
Określ, gdzie nagłówki mają być dokumentowane jako znalezione. Rzeczywista nazwa
w dokumentacji powstaje poprzez dodanie ostatniego składnika nazwy pliku nagłówkowego
do wartości tej wartości domyślnej. Jeśli ta wartość domyślna nie zostanie określona, ​​pełna nazwa pliku
nagłówkowy (dostarczony w wierszu poleceń) z wartością domyślną HeaderDirectory
wcześniej, jest używany. Typowym zastosowaniem tego może być „-Deklaracja podstawy”, gdy
generowanie dokumentacji dla podstawowej biblioteki GNUstep. Spowodowałoby to, że
dokumentacja mówiąca, że ​​NSString jest zadeklarowany w „Foundation/NSString.h”

Zmienne DocumentAllInstance
Ta flaga umożliwia wygenerowanie dokumentacji dla wszystkich zmiennych instancji. Zwykle
udokumentowane zostaną jedynie te, które zostaną wyraźnie uznane za „publiczne” lub „chronione”.

Zmienne instancji dokumentu
Ta flaga pozwala na całkowite wyłączenie dokumentacji np. zmiennych.
Zwykle jawnie zadeklarowane zmienne instancji będą „publiczne” lub „chronione”.
udokumentowane.

Zmienne instancji na końcu
Ta flaga, jeśli jest ustawiona, nakazuje generatorowi HTML umieszczenie dokumentacji zmiennej instancji
na końcu zajęć, a nie na początku. Jest to przydatne, jeśli używasz dużo
chronione zmienne instancji, które będą miały jedynie drugorzędne znaczenie
zwykli użytkownicy klasy.

Katalog Dokumentacji
Może służyć do określenia katalogu, w którym ma zostać umieszczona wygenerowana dokumentacja.
Jeśli nie jest to ustawione, dane wyjściowe są umieszczane w bieżącym katalogu. Ten katalog również jest
używany w ostateczności do lokalizowania plików źródłowych (nie nagłówków), a co ważniejsze, to
jest używany jako drugim i tylko uciekaj się do zlokalizowania wszelkich przesyłanych plików .gsdoc
wiersz poleceń. Wszelkie informacje o ścieżce podane dla tych plików to usunięte i oni są
wyszukiwane w „DocumentationDirectory” (nawet jeśli tak nie było
wygenerowane automatycznie).

Akta
Określa nazwę pliku zawierającego listę nazw plików w postaci tablicy list właściwości
(imię1, imię2,...) format. Jeśli tak jest, nazwy plików na liście argumentów programu
są ignorowane, a nazwy w tym pliku służą jako lista nazw do przetworzenia.

Szablon funkcji
Określ nazwę dokumentu szablonu, w którym ma znajdować się dokumentacja dotycząca funkcji
należy wstawić ze wszystkich plików w projekcie. Jest to przydatne, jeśli źródło funkcji
kod jest rozproszony po wielu plikach i należy go zgrupować w jednym miejscu. Jesteś
odpowiedzialny za zapewnienie, że podstawowy szablon dokumentu (do którego osoba
wstawiono dokumentację funkcji) zawiera wszystkie inne potrzebne informacje, ale
dla wygody autogsdoc wygeneruje prosty szablon (który możesz następnie edytować)
dla Ciebie, jeśli plik nie istnieje. Wstawienie następuje bezpośrednio przed z powrotem
element (lub jeśli taki nie istnieje, bezpośrednio przed końcem ciało element) w
szablon.

Wygeneruj HTML
Może służyć do określenia, czy mają być generowane dane wyjściowe HTML. Domyślnie TAK.

Katalog nagłówków
Można użyć do określenia katalogu, w którym będą przeszukiwane pliki nagłówkowe. W przypadku dostawy
wartość ta jest dodawana do względnych nazw nagłówków, w przeciwnym razie do względnych nazw nagłówków
są interpretowane względem bieżącego katalogu. Pliki nagłówkowe określone jako bezwzględne
To ustawienie domyślne nie ma wpływu na ścieżki.

Ignoruj ​​zależności
Wartość logiczna, której można użyć do określenia, że ​​program powinien ignorować plik
czasy modyfikacji i mimo to regeneruj pliki. Do użytku w połączeniu z
system „make”, który ma samodzielnie zarządzać sprawdzaniem zależności.

Projekty lokalne
Wartość ta służy do kontrolowania automatycznego uwzględniania lokalnych projektów zewnętrznych
system indeksowania służący do generowania odsyłaczy w końcowym dokumencie wyjściowym. Jeśli
ustawiona na „Brak”, wówczas nie są tworzone żadne lokalne odniesienia do projektu, w przeciwnym razie „Lokalne”
Katalog dokumentacji GNUstep jest przeszukiwany rekurencyjnie w poszukiwaniu plików z rozszerzeniem „.igsdoc”
rozszerzenie i wykorzystywane są informacje o indeksowaniu z tych plików. Wartość tego
ciąg jest również używany do generowania nazw plików w odsyłaczu ... jeśli jest to
pusty ciąg znaków, zakłada się, że ścieżką do użycia jest plik w tym samym katalogu, w którym znajduje się plik
Znaleziono plik igsdoc, w przeciwnym razie jest on używany jako przedrostek nazwy w indeksie. Uwaga.
Będą to projekty lokalne o tej samej nazwie, co projekt aktualnie dokumentowany nie
zostać objęte tym mechanizmem. Jeśli chcesz uwzględnić takie projekty, musisz to zrobić
jawnie używając -Projektowanie ...

Szablon makr
Określ nazwę dokumentu szablonu, w którym powinna znajdować się dokumentacja dotycząca makr
zostać wstawione ze wszystkich plików w projekcie. Jest to przydatne, jeśli kod makra jest rozproszony
wokół wielu plików i trzeba je zgrupować w jednym miejscu. Jesteś odpowiedzialny za
zapewnienie, że podstawowy dokument szablonowy (w którym znajduje się indywidualna dokumentacja makro
jest wstawiony) zawiera wszystkie inne potrzebne informacje, ale dla wygody
autogsdoc wygeneruje dla Ciebie prosty szablon (który możesz następnie edytować), jeśli
plik nie istnieje. Wstawienie następuje bezpośrednio przed z powrotem element (lub jeśli
którego nie ma, tuż przed końcem ciało
element) w szablonie.

Utwórz zależności
Nazwa pliku, który będzie używany do wyświetlania informacji o zależnościach dla make. To zajmie
forma wylistowania wszystkich plików nagłówkowych i źródłowych znanych z projektu jako zależności
nazwę projektu (patrz „Projekt”).

Projekt
Może służyć do określenia nazwy tego projektu... określa nazwę indeksu
plik referencyjny stworzony jako część dokumentacji w celu dostarczenia informacji umożliwiających
innych projektach, aby uzyskać odniesienia do elementów tego projektu.

Projekty
Wartość tę można podać w postaci słownika zawierającego ścieżki do pliku igsdoc
pliki indeksowe/odniesienia używane przez projekty zewnętrzne, wraz z wartościami, które mają być użyte do mapowania
nazwy plików znalezione w indeksach. Na przykład, jeśli plik indeksu projektu (igsdoc).
mówi, że klasa „Foo” została znaleziona w pliku „Foo” i powiązana z nią ścieżka
ten indeks projektu to „/usr/share/doc/proj”. Następnie wygenerowane dane wyjściowe HTML mogą się odwoływać
klasę znajdującą się w '/usr/share/doc/prj/Foo.html' . Pamiętaj, że może to być słownik
podane w wierszu poleceń przy użyciu standardowego formatu PropertyList (nie XML
formacie OS X), używając średników jako separatorów linii i zamykając je w postaci pojedynczej
cytaty.

Pokażzależności
Wartość logiczna, której można użyć do określenia, które pliki mają być rejestrowane przez program
są odtwarzane ponownie ze względu na ich zależności od innych plików.

Normy
Wartość logiczna używana do określenia, czy program powinien wstawiać informacje o
zgodności ze standardami w dokumentacji. Należy tego używać tylko wtedy, gdy
dokumentowanie samych bibliotek i narzędzi GNUstep, ponieważ zakłada, że ​​kod
dokumentacja jest częścią GNUstep i prawdopodobnie jest zgodna ze standardem OpenStep
lub implementuje metody kompatybilne z MacOS-X.

Projekty systemowe
Wartość ta służy do kontrolowania automatycznego włączania do systemu projektów zewnętrznych
system indeksowania służący do generowania odsyłaczy w końcowym dokumencie wyjściowym. Jeśli
ustawiony na „Brak”, wówczas nie są wykonywane żadne odniesienia do projektu systemowego, w przeciwnym razie „System”
Katalog dokumentacji GNUstep jest przeszukiwany rekurencyjnie w poszukiwaniu plików z rozszerzeniem „.igsdoc”
rozszerzenie i wykorzystywane są informacje o indeksowaniu z tych plików. Wartość tego
ciąg jest również używany do generowania nazw plików w odsyłaczu ... jeśli jest to
pusty ciąg znaków, zakłada się, że ścieżką do użycia jest plik w tym samym katalogu, w którym znajduje się plik
Znaleziono plik igsdoc, w przeciwnym razie jest on używany jako przedrostek nazwy w indeksie. Uwaga.
Projekty systemowe o tej samej nazwie, co aktualnie dokumentowany projekt nie
zostać objęte tym mechanizmem. Jeśli chcesz uwzględnić takie projekty, musisz to zrobić
jawnie używając -Projektowanie ...

Wpisany szablon defs
Określ nazwę dokumentu szablonu, w którym powinna znajdować się dokumentacja dotycząca typedefs
zostać wstawione ze wszystkich plików w projekcie. Jest to przydatne, jeśli kod źródłowy typedef jest
rozproszone po wielu plikach i trzeba je zgrupować w jednym miejscu. Jesteś
odpowiedzialny za zapewnienie, że podstawowy szablon dokumentu (do którego osoba
typedef) zawiera wszystkie inne potrzebne informacje, ale as
dla wygody autogsdoc wygeneruje prosty szablon (który możesz następnie edytować).
ty, jeśli plik nie istnieje. Wstawienie następuje bezpośrednio przed z powrotem
element (lub jeśli taki nie istnieje, bezpośrednio przed końcem ciało element) w
szablon.

Up Ciąg znaków używany do podania nazwy, która będzie używana w łączu „w górę” z wygenerowanego pliku GSDoc
dokumenty. Zwykle powinna to być nazwa pliku zawierającego indeks
zawartość projektu. Jeśli tego brakuje lub jest ustawiony na pusty ciąg, wówczas nie ma „w górę”
link zostanie podany w dokumentach.

Szablon zmiennych
Określ nazwę dokumentu szablonu, w którym ma znajdować się dokumentacja dotycząca zmiennych
należy wstawić ze wszystkich plików w projekcie. Jest to przydatne, jeśli źródło jest zmienne
kod jest rozproszony po wielu plikach i należy go zgrupować w jednym miejscu. Jesteś
odpowiedzialny za zapewnienie, że podstawowy szablon dokumentu (do którego osoba
wstawiona jest dokumentacja zmienna) zawiera wszystkie inne potrzebne informacje, ale
dla wygody autogsdoc wygeneruje prosty szablon (który możesz następnie edytować)
dla Ciebie, jeśli plik nie istnieje. Wstawienie następuje bezpośrednio przed z powrotem
element (lub jeśli taki nie istnieje, bezpośrednio przed końcem ciało element) w
szablon.

Gadatliwy
Wartość logiczna używana do określenia, czy mają być szczegółowe dane wyjściowe dotyczące debugowania/ostrzeżenia
wytworzony.

Ostrzec
Wartość logiczna używana do określenia, czy chcesz uzyskać standardowe wyjście ostrzegawcze (np. raport o
nieudokumentowanymi metodami).

Mapa słów
Ta wartość jest słownikiem używanym do mapowania identyfikatorów/słów kluczowych znalezionych w plikach źródłowych
innymi słowami. Generalnie nie będziesz musiał z tego korzystać, ale czasami jest to pomocne
aby uniknąć pomylenia parsera przez użycie makr preprocesora C. Możesz
skutecznie przedefiniować makro na coś mniej zagmatwanego. Wartość, którą mapujesz
identyfikator musi być jednym z - Inny identyfikator, Pusty ciąg - wartość to
ignorowane, Dwa ukośniki („//”) – reszta linii jest ignorowana. Pamiętaj, że słownik
można podać w wierszu poleceń, używając standardowego formatu PropertyList (nie formatu
formacie XML systemu OS X), używając średników jako separatorów linii i zamykając je w postaci pojedynczej
cytaty.

MIĘDZYDOKUMENT POŁĄCZENIE

Wartość domyślna „W górę” służy do określenia nazwy dokumentu, który powinien być używany jako plik
Link „w górę” do innych używanych dokumentów. Nazwa ta nie może zawierać ścieżki ani rozszerzenia.
Ogólnie rzecz biorąc, dokument, do którego odnosi się to ustawienie domyślne, powinien być ręcznie edytowanym dokumentem GSDoc
który powinien mieć tylną sekcję zawierającą indeks projektu. np

<? Xml version = "1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


Referencje mojego projektu




Referencje mojego projektu

Korzystaj z autogsdoc online, korzystając z usług onworks.net