gjdoc-4.8 - Online w chmurze

PROGRAM:

IMIĘ

cp-tools — Przewodnik po narzędziach GNU Classpath Tools

STRESZCZENIE

gjdoc [-ścieżkaźródłowa ścieżka]
[-wszystko] [-podpakiety opak: opak:...] [-wykluczać lista pkg]
[-kodowanie charset] [-widownia Nazwa] [-source zwolnić]
[-publiczny] [-chroniony] [-pakiet] [-prywatny]
[-dok XNUMX] [-nagłówek XNUMX] [-stopka XNUMX] [-Dolny XNUMX]
[-połączyć url] [-łącze offline url ścieżka] [-nokwalifikator opak: opak:...]
[-tagletścieżka ścieżka] [-etykietka nazwa klasy] [-etykietka specyfikacja tagu]
[-posługiwać się] [-źródło linków] [-splitindex] [-brak indeksu] [-notree]
[-wersja] [-autor] [- nosence] [-dodaj arkusz stylów filet]
[-d katalog docelowy]
[Pakiety...] [pliki źródłowe...] [@plik cmd]

gjdoc [-ścieżkaźródłowa ścieżka]
[-wszystko] [-podpakiety opak: opak:...] [-wykluczać lista pkg]
[-kodowanie charset] [-widownia Nazwa] [-source zwolnić]
[-publiczny] [-chroniony] [-pakiet] [-prywatny]
[-ścieżka docletu ścieżka] [-dokument nazwa klasy]
[Pakiety...] [pliki źródłowe...] [@plik cmd]
[opcje dokumentu]

gjdoc --help

gjdoc --wersja

Tutaj wymieniono tylko najbardziej przydatne opcje; patrz poniżej dla reszty.

OPIS

Gjdoc może być używany na dwa sposoby: jako samodzielne narzędzie dokumentacji lub jako sterownik dla
określony przez użytkownika Doclet.

W trybie domyślnym Gjdoc użyje standardowego Doclet Dokument HTML wygenerować zestaw
Strony HTML. Zastosowanie kanoniczne to:

gjdoc -s src/java/ -all -d api-docs/

Tutaj, źródło/java/ jest korzeniem hierarchii klas kodu źródłowego, -wszystko oznacza, że ​​wszystkie ważne
Pliki Java znalezione w tym katalogu głównym powinny zostać przetworzone i dokumenty-API/ jest
katalog, w którym należy umieścić wygenerowaną dokumentację.

Aby dowiedzieć się więcej o uruchamianiu Docletów innych niż Standard Doclet, zapoznaj się z instrukcją.

OPCJE

Option Podsumowanie by Rodzaj Nieruchomości

Oto podsumowanie wszystkich opcji Gjdoc i Standard Doclet, pogrupowanych według
rodzaj. Wyjaśnienia znajdują się w kolejnych sekcjach.

Źródło Zestaw Opcje
-ścieżkaźródłowa ścieżka -podpakiety lista pkg -wykluczać lista pkg

Źródło utworzony Opcje
-source zwolnić -kodowanie kodowanie -łamacz

Łączenie Opcje
-połączyć url -łącze offline url filet -nokwalifikator opak: opak:...

Pożądania Opcje
-autor -tekst licencji -posługiwać się -wersja -splitindex -brak indeksu
-węzeł przestarzały -nodeprecatedlista -bez pomocy -nonavbar
- nosence -notree -publiczny -chroniony -pakiet -prywatny
-docfillesssubdirs -excludedocfillesssubdir dirname
-źródło linków

Wydajność Opcje
-d -widownia Nazwa -zestaw znaków charset -docenkodowanie charset
-poprawnyhtml -podstawowy url

Dekoracja Opcje
- tytuł okna XNUMX -dok XNUMX -tytuł XNUMX
-nagłówek XNUMX -stopka XNUMX -Dolny XNUMX
-plik pomocy filet -plik arkusza stylów filet -dodaj arkusz stylów filet
-Grupa nagłówek grupy pkgwzór:pkgwzór:...

Taglet Opcje
-tagletścieżka -etykietka Nazwa klasy -etykietka specyfikacja tagu

Dokument Opcje
-ścieżka docletu -dokument Nazwa klasy

Gadatliwość Opcje
-cichy -gadatliwy

Wirtualny Maszyna Opcje
-ścieżka klasy -ścieżka bootclass -J vmopt

Wybór który Źródło Akta do Przetwarzanie

-s ścieżka
-ścieżkaźródłowa ścieżka
Poszukaj plików źródłowych w określonym katalogu lub katalogach.

ścieżka powinna zawierać co najmniej jedną ścieżkę do katalogu oddzieloną ścieżką Twojej platformy
separator (zwykle : or ;).

Jeśli ta opcja nie zostanie podana, gjdoc będzie szukać plików źródłowych w bieżącym
katalogiem.

Podane katalogi powinny być katalogami głównymi w rozumieniu pakietu Java
system. Na przykład, jeśli chcesz wygenerować dokumentację dla klas w pakiecie
foo.bar, musisz określić katalog zawierający najwyższy poziom bla podkatalog,
nie katalog foo/bar/ w którym znajdują się pliki źródłowe Java.

Skrócony alias -s jest specyficzny dla gjdoc i nie jest kompatybilny z Sun javadoc.

-wszystko
[EKSPERYMENTALNY] Przetwórz wszystkie prawidłowe pliki źródłowe Java znalezione w katalogach wymienionych w
ścieżka źródłowa i ich podkatalogi.

Jest to opcja specyficzna dla gjdoc i nie jest kompatybilny z Sun javadoc.

-podpakiety opak: opak:...
Przetwarzaj klasy w podanych pakietach Javy i wszystkich podpakietach, rekurencyjnie.
Zauważ, że wiele nazw pakietów musi być oddzielonych dwukropkami zamiast spacją.

-wykluczać opak: opak:...
Nie przetwarzaj rekurencyjnie klas w podanych pakietach Javy i wszystkich pod-pakietach.
Ta opcja może być używana w połączeniu z -wszystko or -podpakiety w celu wykluczenia
pojedyncze pakiety lub poddrzewa pakietów z danych wyjściowych.

Pakiety...
Przetwarzaj wszystkie klasy w podanych pakietach Java.

pliki źródłowe...
Przetwórz klasy w podanych plikach źródłowych Java.

Określanie dotychczasowy utworzony of Wkład Akta

-source zwolnić
Załóżmy, że pliki źródłowe są przeznaczone dla danej wersji platformy Java.

zwolnić powinien być numerem wersji wydania platformy Java w formacie
MAJOR.MINOR, na przykład 1.4.

Ta opcja jest obecnie ignorowana, z wyjątkiem tego, że w przypadku wydania numeru pojawia się błąd
inne niż 1.2, 1.3 or 1.4 jest specyficzne.

-kodowanie charset
Załóżmy, że pliki źródłowe są zakodowane przy użyciu charset.

Przykłady dla charset jest US-ASCII, ISO-8859-1 or UTF-8.

Semantyka charset są identyczne z tymi z
java.nio.charset.Charset.forName(Ciąg).

-łamacz
Użyj java.text.BreakIterator ustawień regionalnych zamiast wewnętrznego pierwszego zdania
detektor.

Domyślnie gjdoc używa wewnętrznego algorytmu do określenia, gdzie kończy się zdanie. Kiedy
ta opcja jest podana, zamiast tego użyje java.text.BreakIterator przykład dla
lokalizacja podana z -widownia (lub domyślne ustawienia regionalne).

Tę opcję należy określić podczas składania wniosku gjdoc do kodu źródłowego skomentowanego w nie-
język łaciński, dla którego domyślny detektor pierwszego zdania nie działa. Dla wszystkich
w innych przypadkach domyślnie (nie używaj BreakIterator) daje lepsze wyniki na
czas tego pisania.

Łączenie w inny Dokumenty Zestawy

-połączyć url
Utwórz hiperłącza do innego zestawu dokumentacji.

Domyślnie gjdoc utworzy tylko hiperłącza do klas w zestawie źródłowym. Użyj tego
możliwość dodatkowego tworzenia hiperłączy do klas objętych określonym
zestaw dokumentacji.

url powinien być głównym adresem URL innego zestawu dokumentacji. Na przykład, aby dodać
hiperłącza do ścieżki klasy GNU, określ następujące elementy:

-połączyć http://developer.classpath.org/doc/

Połączenia -połączyć opcję można podać wielokrotnie.

Zwróć uwagę, że określenie -połączyć opcja spowoduje dostęp HTTP za każdym razem, gdy gjdoc jest
powołany. Możesz użyć -łącze offline zamiast tego, aby uniknąć tego dostępu.

-łącze offline url filet
Utwórz hiperłącza do innego zestawu dokumentacji, który jest również obecny w lokalnym pliku
pomimo napiętego harmonogramu

Ta opcja działa dokładnie tak, jak -połączyć, z wyjątkiem tego, że uzyskuje dostęp do lokalnego systemu plików
zamiast sieci do określania, które klasy są objęte powiązanym
zestaw dokumentacji.

Podczas używania -łącze offline zdalny zestaw dokumentacji nie jest w ogóle dostępny, co może
znacznie przyspieszyć czas generowania w zależności od połączenia sieciowego. ten
wygenerowane hiperłącza do zestawu dokumentacji odnoszą się jednak do zestawu zdalnego, a nie do
lokalny, dzięki czemu można bez dalszych rozprowadzać dokumentację
zależności.

Połączenia -łącze offline opcję można podać wielokrotnie.

-nokwalifikator opak: opak:...
Nie kwalifikuj nazw klas w podanych pakietach ich nazwą pakietu.

Domyślnie nazwa klasy jest wyświetlana bez kwalifikacji tylko wtedy, gdy klasa jest częścią
zestaw źródłowy lub połączony zestaw dokumentacji i zakwalifikowany nazwą swojego
zawierające pakiet, jeśli nie jest. Możesz użyć tej opcji, aby wymusić niekwalifikowane nazwy
dla klas, nawet jeśli nie są one częścią zestawu dokumentacji.

Na przykład, zwykle odwołanie do klasy String jest reprezentowane jako w pełni kwalifikowane jako
java.lang.String (chyba że łączysz się z odpowiednim zestawem dokumentacji za pomocą -połączyć)
ponieważ nie jest częścią zestawu dokumentacji. Możesz określić -nokwalifikator
Java.lang renderować te same referencje, tak jak sznur.

Zwróć uwagę, że w przypadku wszystkich niekwalifikowanych nazw klas, po umieszczeniu swojego
wskaźnik myszy nad nim w dokumentacji HTML.

-nokwalifikator cała kolekcja
Pomiń kwalifikator nazwy pakietu ze wszystkich nazw klas.

Określ tę opcję, aby całkowicie pominąć kwalifikatory nazwy pakietu,

Wybór który Informacja do Generuj swój

-publiczny
Uwzględnij w danych wyjściowych tylko członków publicznych klas publicznych. Domyślnie chroniony
uwzględniono również członków klasy.

-chroniony
Uwzględnij w wynikach publicznych lub chronionych członków klas publicznych. To jest
domyślna.

-pakiet
Uwzględnij publicznych, chronionych i pakietowo-prywatnych członków publicznych i pakietowo-prywatnych
Klasy.

-prywatny
Uwzględnij wszystkie klasy i członków klasy, niezależnie od ich poziomu dostępu.

-splitindex
Generuj jedną stronę indeksu na literę zamiast pojedynczej, monolitycznej strony indeksu.

Domyślnie indeks utworzony przez Standard Doclet zawiera wszystkie wpisy w jednym
strona. Jest to dobre dla małych zestawów dokumentacji, ale w przypadku dużych zestawów powinieneś
określ tę opcję.

- nosence
ignorować @odkąd tagi w komentarzach javadoc.

Domyślnie wygenerowane dane wyjściowe zawierają sekcje z listą wersji Twojego API
od którego istnieje dany pakiet, klasa lub członek klasy, gdy ten znacznik jest
napotkane. Wybierz tę opcję, aby pominąć te informacje.

-notree
Nie generuj żadnych stron drzewa.

Domyślnie wygenerowane dane wyjściowe zawierają jedno drzewo dziedziczenia na pakiet oraz - jeśli
zestaw dokumentacji składa się z wielu pakietów - strona z pełnym dziedziczeniem
drzewo. Wybierz tę opcję, aby pominąć generowanie tych stron.

-brak indeksu
Nie wyświetlaj indeksu alfabetycznego.

Domyślnie gjdoc generuje indeks alfabetyczny wszystkich elementów programu w
zestaw dokumentacji (pakiety, klasy, klasy wewnętrzne, konstruktory, metody i
pola). Wybierz tę opcję, aby pominąć te informacje.

-bez pomocy
Nie generuj strony pomocy.

Ta opcja jest obecnie ignorowana, ponieważ Standard Doclet nie zawiera strony pomocy.

-węzeł przestarzały
Nie wyświetlaj informacji wbudowanych o przestarzałych pakietach, klasach ani członkach klasy.

Domyślnie Standard Doclet dodaje podświetlony akapit z wycofaniem
informacje do opisu każdego przestarzałego elementu programu. Określ to
możliwość pominięcia tej informacji.

-nodeprecatedlista
Nie wyświetlaj strony podsumowania dla przestarzałych elementów interfejsu API.

Domyślnie Standard Doclet generuje stronę zawierającą listę wszystkich przestarzałych elementów API
wraz z opisem wycofania, który zwykle zawiera powód wycofania
i możliwe alternatywy. Wybierz tę opcję, aby pominąć te informacje.

-nonavbar
Nie wyświetlaj paska nawigacyjnego, nagłówka ani stopki.

Domyślnie każda strona wyjściowa jest wyposażona w górny pasek nawigacyjny (który może zawierać
nagłówek określony przez użytkownika) i dolny pasek nawigacyjny (który może zawierać
określonej stopce). Wybierz tę opcję, aby pominąć tę dekorację.

-bez komentarza
Pomiń cały tekst dokumentacji z wygenerowanych plików i wypisz tylko deklaracje i
relacje elementów programu.

Ta opcja jest dostępna w celu zapewnienia zgodności z javadoc. Jeśli planujesz wydobycie
informacje o Twoim projekcie przez gjdoc, powinieneś rozważyć użycie innego Doclet
do twoich celów, na przykład XmlDoclet. Możesz także skorzystać z Doclet API
bezpośrednio poprzez wdrożenie nowego Doclet.

-źródło linków
Wygeneruj stronę z kodem źródłowym z podświetleniem składni dla każdej klasy. Domyślnie to
strona nie jest generowana.

Dostęp do kodu źródłowego można uzyskać, klikając przycisk oznaczony „Źródło” w
pasek nawigacji lub klikając nazwę konstruktora, pola, metody lub wewnętrznej
class w sekcji szczegółów na stronie dokumentacji klasy.

-posługiwać się
Wygeneruj stronę z informacjami o odsyłaczach. Domyślnie ta strona nie jest
wygenerowane.

Dostęp do informacji o odsyłaczach można uzyskać, klikając przycisk oznaczony
'Użyj' na pasku nawigacyjnym.

Strona `Use' zawiera listę wszystkich klas/interfejsów w zestawie dokumentacji, które
rozszerzenie/zaimplementowanie danej klasy (typu); pola typu; metody lub
konstruktory akceptujące parametr typu; metody zwracające typ; oraz
metody lub konstruktory rzucające typ.

-autor
Uwzględnij w danych wyjściowych informacje o autorze.

Po określeniu informacje o autorze określone za pomocą @autor tag w javadoc
komentarze są włączane do danych wyjściowych. Domyślnie, @autor tagi są ignorowane.

-wersja
Uwzględnij informacje o wersji w danych wyjściowych.

Jeśli określono, informacje o wersji określone za pomocą @wersja tag w javadoc
komentarze są włączane do danych wyjściowych. Domyślnie, @wersja tagi są ignorowane.

-tekst licencji
Załóżmy, że pierwszy komentarz w każdym pliku źródłowym zawiera tekst licencji i dodaj
informacje o licencji do stopki każdej wygenerowanej strony klasy.

Jest to opcja specyficzna dla gjdoc i nie jest kompatybilny z Sun javadoc.

Ta opcja jest przeznaczona do użytku z projektami darmowymi i open source, w których kod źródłowy
jest zazwyczaj poprzedzone komentarzem dotyczącym licencji wzorcowej, gdy istnieją powody prawne
za umieszczenie licencji w dokumentacji.

-docfillesssubdirs
Rekursywnie skopiuj wszystkie pliki w pliki doc podkatalog każdego katalogu pakietów.

Zwykle tylko pliki w pliki doc podkatalog są kopiowane bez schodzenia
rekurencyjnie.

-excludedocfillesssubdir Nazwa:Nazwa: ...
Nie kopiuj niektórych katalogów bezpośrednio pod pliki doc podkatalogi, gdy
malejąco rekurencyjnie.

Argumentem tej opcji powinna być rozdzielona dwukropkami lista nazw katalogów.

Ta opcja ma sens tylko wtedy, gdy -docfillesssubdirs jest również określony. W tym przypadku każdy
podkatalog znajdujący się bezpośrednio pod a pliki doc katalog jest pomijany, jeśli jest wymieniony.

Zamówienia Indywidualne Dokumenty Tagi

-tagletścieżka ścieżka
Szukaj ścieżka podczas ładowania kolejnych klas Taglet określonych za pomocą -etykietka.

ścieżka powinna być co najmniej jedną ścieżką do katalogu lub pliku jar, oddzieloną od siebie
separator ścieżki platformy (zwykle : or ;).

-etykietka Nazwa klasy
Zarejestruj taglet.

Nazwa klasy powinna być w pełni kwalifikowaną nazwą implementującej klasy Java
com.sun.tools.doclets.Taglet.

Klasy Taglet będą ładowane ze ścieżki klasy określonej za pomocą -tagletścieżka, od
ścieżka klasy określona przy użyciu -ścieżka klasy iz domyślnej ścieżki klas.

Zobacz dokumentację com.sun.tools.doclets.Taglet w celu uzyskania dalszych informacji.

Zwróć uwagę, że w przypadku prostych tagów istnieje również -etykietka.

-etykietka specyfikacja tagu
Zarejestruj ogólny Taglet.

Format specyfikacja tagu musi być : :" ".

Nazwa znacznika to nazwa tagu do dopasowania, bez początkowego znaku @.

Flagi to jeden lub więcej z następujących znaków, gdzie każdy znak określa
kontekst kodu źródłowego, w którym tag ma być rozpoznany.

a wszystkie konteksty

c konstruktorzy

f Pola

m metody

o przegląd

p Pakiety

t typy (klasy, interfejsy, wyjątki, błędy)

X znak specjalny, który tymczasowo całkowicie wyłącza Taglet.

taghead jest ciągiem do wyświetlenia w nagłówku sekcji poświęconej tagowi w
pytanie.

Na przykład, aby zdefiniować pasujący tag @cvsid który należy zaakceptować w przeglądzie,
strony pakietu i typu i które są oznaczone nagłówkiem CVS ID, tak byś
sprecyzować:

-tag cvsid:tpo:"ID CVS"

Załóżmy, że komentarz javadoc klasy zawiera

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Wtedy wynik HTML będzie zawierał coś takiego:

Identyfikator CVS:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Bieganie Inne Doclety

-ścieżka docletu ścieżka
Szukaj ścieżka podczas ładowania klas dla Doclet określonego przy użyciu -dokument.

ścieżka powinna być co najmniej jedną ścieżką do katalogu lub pliku jar, oddzieloną od siebie
separator ścieżki platformy (zwykle : or ;).

-dokument nazwa klasy
Uruchom określony doclet zamiast standardowego HtmlDoclet.

nazwa klasy powinna być w pełni kwalifikowaną nazwą klasy, która ma publiczną wartość domyślną
konstruktora i zawierają metodę o następującej sygnaturze:

importuj com.sun.javadoc.RootDoc;
publiczny statyczny start logiczny (RootDoc ​​rootDoc)

Klasy Doclet będą ładowane ze ścieżki klasy określonej za pomocą -ścieżka docletu, od
ścieżka klasy określona przy użyciu -ścieżka klasy iz domyślnej ścieżki klas.

Połączenia początek metoda powinna przetwarzać informacje ujawnione przez Doclet API poprzez rootDoc
i wróć prawdziwy na sukcesie, fałszywy w przypadku niepowodzenia.

Jeśli korzystasz z doclet innej firmy, zapoznaj się z jego dokumentacją, aby uzyskać więcej informacji
instrukcje. Pamiętaj, że obsługa docletów innych firm jest eksperymentalna. Proszę
zgłaszaj wszelkie napotkane problemy lub przesyłaj informacje zwrotne po pomyślnym uruchomieniu
aplety innych firm.

Tę opcję można podać wiele razy, w którym to przypadku wykonywane są wszystkie pliki doclet
z tym samym drzewem informacji udostępnianym za pośrednictwem interfejsu Doclet API dla każdego uruchomienia Doclet.

Dodawanie Informacja do dotychczasowy Wydajność

- tytuł okna XNUMX
Zastosowanie XNUMX jako przedrostek tytułu okna przeglądarki.

Po określeniu tytuł okna przeglądarki dla każdej strony będzie poprzedzony znakiem XNUMX
zamiast domyślnego ciągu generowane API Dokumenty.

XNUMX powinien być zwykłym tekstem (nie powinien zawierać znaczników HTML).

-dok XNUMX
Ustaw tekst nagłówka strony przeglądu na XNUMX.

XNUMX powinien być krótkim, zwykłym ciągiem tekstowym.

Przy generowaniu dokumentacji dla pojedynczego pakietu określenie tej opcji wymusza
generowanie strony przeglądu.

-nagłówek tekst html
Dodaj tekst html w prawym górnym rogu każdej wygenerowanej strony. tekst html zazwyczaj jest
ustawić na nazwę dokumentowanego projektu.

-stopka tekst html
Dodaj tekst html w prawym dolnym rogu każdej wygenerowanej strony. tekst html jest częste
ustawić na taką samą wartość jak dla -nagłówek.

-Dolny tekst html
Dodaj tekst html na sam dół każdej wygenerowanej strony, obejmując całą szerokość
Strona. Jeśli określono, tekst html zwykle składa się z informacji o prawach autorskich i/lub
linki do innych stron projektu.

-dodaj arkusz stylów filet
Rozszerz domyślne arkusze stylów CSS o arkusz stylów określony przez użytkownika filet.

Dany arkusz stylów jest po prostu ładowany przez każdą stronę HTML oprócz domyślnego
te, jako ostatni arkusz stylów.

Pamiętaj, że obowiązują reguły kaskadowe CSS. Oznacza to, że Twoje właściwości stylu będą tylko
przypisane, jeśli mają wyższą kolejność kaskadową niż gjdocdomyślny styl. Jeden prosty
sposobem, aby upewnić się, że tak jest, jest zadeklarowanie nadpisań ! important.

Widziećhttp://www.w3.org/TR/REC-CSS2/cascade.html#kaskadowa kolejność>.

-Grupa nagłówek pkgwildcard:pkgwildcard: ...
Uporządkuj dane pakiety w osobnej grupie na stronie przeglądu.

Pierwszym argumentem powinien być krótki zwykły tekst, który jest używany jako tytuł
grupa pakietów. Drugi argument powinien być rozdzieloną dwukropkami listą pakietów
symbole wieloznaczne. Grupa będzie się składać ze wszystkich pakietów w zestawie dokumentacji, których nazwa
pasuje do dowolnego z podanych symboli wieloznacznych.

Jest tylko jeden znak wieloznaczny, *, który pasuje do obu liter w nazwie pakietu
komponenty i . oddzielanie składników nazw pakietów. Na przykład, j*wyrażenie regularne by
dopasuj pakiet Java.util.regex. Bardziej użytecznym przykładem byłoby: javax.swing* dopasować
javax.swing i wszystkie jego podpakiety.

Tę opcję można podać wielokrotnie.

FIXME: Informacje o zagnieżdżaniu grup tutaj.

gjdoc -group "Klasy podstawowe" 'java*' \
-group "Swing" 'javax.swing*' \
-group "Interfejsy API XML" 'javax.xml*' \
-group "Inne rozszerzenia" javax* \
...

-Przegląd filet
Dodaj fragment treści XHTML z filet do strony przeglądu.

filet powinien zawierać fragment XHTML z kodem HTML ciało tag jako węzeł główny.

Ta opcja może być wykorzystana do dostarczenia opisu kompletu dokumentacji jako całości.

Po określeniu pierwsze zdanie fragmentu zostanie umieszczone nad tabelami
wyszczególnienie udokumentowanych pakietów wraz z linkiem do pełnej kopii fragmentu
który znajduje się pod tabelami.

Przy generowaniu dokumentacji dla pojedynczego pakietu określenie tej opcji wymusza
generowanie strony przeglądu.

-plik arkusza stylów filet
Użyj arkusza stylów CSS w filet zamiast domyślnych arkuszy stylów CSS.

Jeśli chcesz tylko nadpisać części domyślnych arkuszy stylów, użyj -dodaj arkusz stylów
zamiast.

-tytuł XNUMX
Przestarzałe. Zastosowanie -dok XNUMX zamiast.

-plik pomocy filet
Ta opcja jest obecnie ignorowana.

Po zaimplementowaniu użyje fragmentu XHTML w filet za zawartość strony pomocy
zamiast domyślnego tekstu pomocy.

Sterowanie dotychczasowy Wydajność.

-d katalog
Umieść wszystkie pliki wyjściowe w katalog (i podkatalogi). katalog zostanie stworzony
jeśli nie istnieje, w tym wszystkie nieistniejące katalogi nadrzędne i wszystkie wymagane
podkatalogi.

Jeśli nie zostanie określony, dane wyjściowe zostaną umieszczone w bieżącym katalogu.

-widownia Nazwa
Użyj ustawień regionalnych Nazwa zamiast domyślnych ustawień regionalnych do wszystkich celów.

Nazwa powinien być specyfikatorem ustawień regionalnych w formularzu ll_CC[_VAR] gdzie ll jest małą literą
literowy kod języka ISO-639, CC jest opcjonalnym krajem ISO-3166 składającym się z dwóch wielkich liter
kod i VAR to opcjonalny kod wariantu. Na przykład, en określa język angielski, pl
określa amerykański angielski i pl_US_WIN określa odmienną odmianę amerykańskiego angielskiego
widownia.

Zauważ, że semantyka tej opcji odpowiada dokładnie semantyce konstruktorów
klasy Java.util.Locale.

Ta opcja obecnie określa tylko, który Collator jest używany do sortowania danych wyjściowych
elementy. Oznacza to, że ustawienia regionalne będą działać tylko wtedy, gdy używasz nie-
Znaki ASCII w identyfikatorach.

-zestaw znaków charset
Przestarzałe. Zastąp określone kodowanie w wyjściowych plikach XHTML kodem podanym
by charset.

Jeśli ta opcja nie jest podana, specyfikacja kodowania w wyjściowym XHTML jest wybierana jako
dopasuj kodowanie użyte podczas zapisywania pliku (kodowanie podane za pomocą -docenkodowanie,
lub domyślne kodowanie platformy).

Semantyka dla charset są określone tutaj:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncNazwa>. Do wszystkich celów praktycznych,
są one identyczne jak w innych opcjach akceptujących parametry zestawu znaków.

Ta opcja jest dostępna w celu zapewnienia zgodności z javadoc i należy ich unikać.

-docenkodowanie charset
Używaj podanego kodowania zestawu znaków podczas pisania plików wyjściowych, a nie swojej platformy
domyślne kodowanie.

Przykłady dla charset jest US-ASCII, ISO-8859-1 or UTF-8.

Semantyka tej opcji dokładnie odpowiada semantyce konstruktorów class
Java.util.Locale.

-poprawnyhtml
Wymuś generowanie prawidłowego kodu XHTML. To łamie kompatybilność z tradycyjnym
Narzędzie Javadoc do pewnego stopnia.

Jeśli ta opcja jest określona, ​​nazwy kotwic zostaną zniekształcone, aby były poprawne
zgodnie ze specyfikacją XHTML 1.1. Jednak zestaw dokumentacji wygenerowany za pomocą
ta opcja nie może być poprawnie połączona za pomocą tradycyjnego narzędzia Javadoc. To może
być połączonym z dobrym używaniem Gjdoc.

Bez tej opcji nazwy kotwic dla wykonywalnych członków klasy używają tradycyjnej
format, na przykład: "foo(Ciąg,int[])". Jest to zgodne z tradycyjnym
narzędzie Javadoc, ale zgodne zarówno ze specyfikacją HTML 4.0, jak i XHTML 1.0 i 1.1,
ten format zawiera niedozwolone znaki. Nawiasy, nawiasy kwadratowe i przecinek
nie są dozwolone w nazwach kotwic.

-podstawowy url
Zaprogramuj adres URL strony względem url do każdej wygenerowanej strony.

Jeśli generujesz dokumentację, która będzie dostępna wyłącznie w określonym czasie
URL, należy użyć tej opcji, aby określić ten adres URL.

Może to pomóc w uniknięciu niektórych ataków przekierowujących wykorzystywanych przez spamerów i może być pomocne
dla niektórych klientów internetowych.

Gadatliwość Opcje

-cichy
Pomiń wszystkie dane wyjściowe z wyjątkiem ostrzeżeń i komunikatów o błędach.

-gadatliwy
Bądź bardzo gadatliwy o czym gjdoc to robi.

Ta opcja jest obecnie ignorowana.

Wirtualny Maszyna Opcje

Słońce javadoc narzędzie wydaje się być oparte na javac i jako taki wydaje się działać na VM
poziom. gjdoc, w przeciwieństwie do tego, jest czystą aplikacją Java.

Dlatego gjdoc może tylko fałszować lub symulować następujące opcje na poziomie maszyny wirtualnej.

-ścieżka klasy ścieżka
Ustaw maszynę wirtualną ścieżka klasy do ścieżka.

W większości przypadków powinieneś użyć -ścieżka docletu or -tagletścieżka zamiast tej opcji.

ścieżka powinna być co najmniej jedną ścieżką do katalogu lub pliku jar, oddzieloną od siebie
separator ścieżki platformy (zwykle : or ;).

Jeśli ta opcja nie jest przechwytywana na poziomie opakowania, gjdoc obecnie podrabia to przez
powołanie System.setProperty("java.class.path", ścieżka); i wyświetla ostrzeżenie.

-ścieżka bootclass ścieżka
Ustaw maszynę wirtualną ścieżka bootclass do ścieżka.

Jeśli ta opcja nie jest przechwytywana na poziomie opakowania, gjdoc generuje ostrzeżenie.

-Jvmopt
Przekaż dowolny parametr do maszyny wirtualnej gjdoc biegnie dalej.

Jeśli ta opcja nie jest przechwytywana na poziomie opakowania, gjdoc próbuje naśladować
opcja i wyświetla ostrzeżenie.

Obecnie tylko opcja VM -D do ustawiania właściwości systemu jest emulowany.

Korzystaj z gjdoc-4.8 online za pomocą usług onworks.net