gjdoc-4.8 – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

cp-tools – GNU Classpath Tools-Handbuch

ZUSAMMENFASSUNG

gjdoc [-Quellenpfad Pfadliste]
[-alles] [-Unterpakete Paket:Paket:...] [-ausschließen Paketliste]
[-Codierung charset] [-Gebietsschema Name] [-source Release]
[-Öffentlichkeit] [-geschützt] [-Paket] [-Privat]
[-doctitle Text] [-Header Text] [-Fusszeile Text] [-Unterseite Text]
[-Verknüpfung URL] [-linkoffline URL Weg] [-noqualifier Paket:Paket:...]
[-tagletpath Pfadliste] [-taglet Klassenname] [-Etikett Tagsspez]
[-verwenden] [-Linkquelle] [-Splitindex] [-noindex] [-notree]
[-Ausführung] [-Autor] [-nosince] [-addstylesheet Datei]
[-d Zielverzeichnis]
[Pakete...] [Quelldaten...] [@cmd-Datei]

gjdoc [-Quellenpfad Pfadliste]
[-alles] [-Unterpakete Paket:Paket:...] [-ausschließen Paketliste]
[-Codierung charset] [-Gebietsschema Name] [-source Release]
[-Öffentlichkeit] [-geschützt] [-Paket] [-Privat]
[-docletpath Pfadliste] [-doclet Klassenname]
[Pakete...] [Quelldaten...] [@cmd-Datei]
[Doclet-Optionen]

gjdoc --help

gjdoc --Version

Hier sind nur die nützlichsten Optionen aufgeführt; den Rest siehe unten.

BESCHREIBUNG

Gjdoc kann auf zwei Arten verwendet werden: als eigenständiges Dokumentationstool oder als Treiber für ein
Benutzerdefiniertes Doclet.

Im Standardmodus verwendet Gjdoc das Standard-Doclet HtmlDoclet um eine Reihe von zu generieren
HTML-Seiten. Die kanonische Verwendung ist:

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

Hier src/java/ ist die Wurzel Ihrer Quellcode-Klassenhierarchie, -alles bedeutet, dass alles gültig ist
Unter diesem Stammverzeichnis gefundene Java-Dateien sollten verarbeitet werden API-Dokumente/ lernen muss die
Verzeichnis, in dem die generierte Dokumentation abgelegt werden soll.

Weitere Informationen zum Ausführen anderer Doclets als des Standard-Doclets finden Sie im Handbuch.

OPTIONAL

Option Zusammenfassung by Typ

Hier ist eine Zusammenfassung aller Optionen von Gjdoc und dem Standard-Doclet, gruppiert nach
Typ. Erläuterungen finden Sie in den folgenden Abschnitten.

Quelle Sept Optionen
-Quellenpfad Pfadliste -Unterpakete Paketliste -ausschließen Paketliste

Quelle Format Optionen
-source Release -Codierung Codierung -Breakiterator

Verknüpfung Optionen
-Verknüpfung URL -linkoffline URL Datei -noqualifier Paket:Paket:...

Generation Optionen
-Autor -Lizenztext -verwenden -Ausführung -Splitindex -noindex
-nodeprecated -nodeprecatedlist -Keine Hilfe -nonavbar
-nosince -notree -Öffentlichkeit -geschützt -Paket -Privat
-docfilessubdirs -excludedocfilessubdir dirname
-Linkquelle

Output Optionen
-d -Gebietsschema Name -Zeichensatz charset -Dokumentenkodierung charset
-validhtml -baseurl URL

Dekoration Optionen
-Fenstertitel Text -doctitle Text -Titel Text
-Header Text -Fusszeile Text -Unterseite Text
-Hilfedatei Datei -stylesheetfile Datei -addstylesheet Datei
-Gruppe Gruppenüberschrift Paketmuster:Paketmuster:...

Taglet Optionen
-tagletpath -taglet Klassenname -Etikett Tagsspez

Doclet Optionen
-docletpath -doclet Klassenname

Ausführlichkeit Optionen
-ruhig -verbose

Assistent Maschine Optionen
-Klassenpfad -bootclasspath -J vmopt

Auswahl welche Quelle Mappen zu Prozess

-s Pfadliste
-Quellenpfad Pfadliste
Suchen Sie im angegebenen Verzeichnis bzw. in den angegebenen Verzeichnissen nach Quelldateien.

Pfadliste sollte ein oder mehrere Verzeichnispfade sein, die durch den Pfad Ihrer Plattform getrennt sind
Trennzeichen (normalerweise : or ;).

Wenn diese Option nicht gegeben ist, gjdoc sucht im aktuellen nach Quelldateien
Verzeichnis.

Die angegebenen Verzeichnisse sollten Stammverzeichnisse im Sinne des Java-Pakets sein
System. Wenn Sie beispielsweise eine Dokumentation für Klassen im Paket erstellen möchten
foo.bar, müssen Sie das Verzeichnis angeben, das die oberste Ebene enthält foo Unterverzeichnis,
nicht das Verzeichnis foo/bar/ in dem sich die Java-Quelldateien befinden.

Der Kurzalias -s ist spezifisch für gjdoc und nicht kompatibel zu Sun javadoc.

-alles
[EXPERIMENTAL] Verarbeiten Sie alle gültigen Java-Quelldateien, die in den in aufgeführten Verzeichnissen gefunden werden
den Quellpfad und ihre Unterverzeichnisse.

Dies ist eine spezifische Option für gjdoc und nicht kompatibel zu Sun javadoc.

-Unterpakete Paket:Paket:...
Verarbeiten Sie die Klassen in den angegebenen Java-Paketen und allen Unterpaketen rekursiv.
Beachten Sie, dass mehrere Paketnamen durch Doppelpunkte statt durch Leerzeichen getrennt werden müssen.

-ausschließen Paket:Paket:...
Verarbeiten Sie Klassen in den angegebenen Java-Paketen und allen Unterpaketen nicht rekursiv.
Diese Option kann in Verbindung mit verwendet werden -alles or -Unterpakete um auszuschließen
einzelne Pakete oder Paketunterbäume aus der Ausgabe.

Pakete...
Verarbeiten Sie alle Klassen in den angegebenen Java-Paketen.

Quelldaten...
Verarbeiten Sie die Klassen in den angegebenen Java-Quelldateien.

Angeben Format of zufuhr Mappen

-source Release
Gehen Sie davon aus, dass die Quelldateien auf die jeweilige Version der Java-Plattform ausgerichtet sind.

Release sollte die Versionsnummer einer Java-Plattformversion im Format sein
Zum Beispiel MAJOR.MINOR 1.4.

Diese Option wird derzeit ignoriert, mit der Ausnahme, dass bei einer Versionsnummer ein Fehler ausgelöst wird
ausgenommen 1.2, 1.3 or 1.4 angegeben.

-Codierung charset
Gehen Sie davon aus, dass die Quelldateien mit codiert sind charset.

Beispiele für charset sind US-ASCII, ISO-8859-1 or UTF-8.

Die Semantik von charset sind identisch mit denen von
java.nio.charset.Charset.forName(String).

-Breakiterator
Verwenden Sie den java.text.BreakIterator des Gebietsschemas anstelle des internen ersten Satzes
Detektor.

Standardmäßig gjdoc verwendet einen internen Algorithmus, um zu bestimmen, wo ein Satz endet. Wann
Diese Option ist gegeben, stattdessen wird die verwendet java.text.BreakIterator Beispiel für die
Gebietsschema angegeben mit -Gebietsschema (oder das Standardgebietsschema).

Diese Option sollte bei der Bewerbung angegeben werden gjdoc zum Quellcode, der in einer nicht-kommentierten Form kommentiert wurde
lateinische Sprache, für die der Standard-Detektor für den ersten Satz nicht funktioniert. Für alle
In anderen Fällen führt die Standardeinstellung (BreakIterator nicht verwenden) zu besseren Ergebnissen
Zeitpunkt dieses Schreibens.

Verknüpfung mit Sonstiges Dokumentation Sets

-Verknüpfung URL
Erstellen Sie Hyperlinks zu einem anderen Dokumentationssatz.

Standardmäßig gjdoc erstellt nur Hyperlinks zu Klassen im Quellsatz. Benutze das
Option, um zusätzlich Hyperlinks zu den von der angegebenen Klasse abgedeckten Klassen zu erstellen
Dokumentationsset.

URL sollte die Stamm-URL des anderen Dokumentationssatzes sein. Zum Beispiel hinzufügen
Geben Sie für Hyperlinks zum GNU-Klassenpfad Folgendes an:

-Verknüpfung http://developer.classpath.org/doc/

Das -Verknüpfung Option kann mehrfach angegeben werden.

Beachten Sie, dass die Angabe von -Verknüpfung Die Option führt bei jedem Zugriff auf gjdoc einen HTTP-Zugriff aus
aufgerufen. Sie können verwenden -linkoffline stattdessen diesen Zugriff zu vermeiden.

-linkoffline URL Datei
Erstellen Sie Hyperlinks zu einem anderen Dokumentationssatz, der ebenfalls in der lokalen Datei vorhanden ist
System funktionieren.

Diese Option funktioniert genauso wie -Verknüpfung, außer dass es auf das lokale Dateisystem zugreift
anstelle des Netzwerks, um zu bestimmen, welche Klassen von den verknüpften Klassen abgedeckt werden
Dokumentationsset.

Beim Benutzen -linkoffline Auf den Remote-Dokumentationssatz wird überhaupt nicht zugegriffen, was möglich ist
Verkürzen Sie die Generierungszeit je nach Netzwerkverbindung erheblich. Der
Generierte Hyperlinks zum Dokumentationsset beziehen sich jedoch auf das Remote-Set, nicht auf
die lokale, so dass Sie die Dokumentation ohne weiteres weitergeben können
Abhängigkeiten.

Das -linkoffline Option kann mehrfach angegeben werden.

-noqualifier Paket:Paket:...
Qualifizieren Sie Namen von Klassen in den angegebenen Paketen nicht mit ihrem Paketnamen.

Standardmäßig wird ein Klassenname nur dann unqualifiziert angezeigt, wenn die Klasse Teil von ist
Quellsatz oder ein verknüpfter Dokumentationssatz und qualifiziert mit dem Namen davon
enthält das Paket, wenn dies nicht der Fall ist. Mit dieser Option können Sie unqualifizierte Namen erzwingen
für Klassen, auch wenn sie nicht Teil des Dokumentationssatzes sind.

Beispielsweise wird normalerweise ein Verweis auf die String-Klasse vollständig qualifiziert als dargestellt
java.lang.String (es sei denn, Sie verlinken mit auf den entsprechenden Dokumentationssatz -Verknüpfung)
weil es nicht Teil der Dokumentation ist. Sie können angeben -noqualifier
java.lang um die gleichen Referenzen genauso wiederzugeben Schnur.

Beachten Sie, dass für alle nicht qualifizierten Klassennamen beim Platzieren Ihrer Klasse ein Tooltip angezeigt wird
Mauszeiger darüber in der HTML-Dokumentation.

-noqualifier alle
Lassen Sie das Qualifikationsmerkmal für den Paketnamen in allen Klassennamen weg.

Geben Sie diese Option an, um Paketnamen-Qualifizierer vollständig wegzulassen.

Auswahl welche Informationen zu Generieren

-Öffentlichkeit
Schließen Sie nur öffentliche Mitglieder öffentlicher Klassen in die Ausgabe ein. Standardmäßig geschützt
Auch die Klassenmitglieder sind dabei.

-geschützt
Beziehen Sie öffentliche oder geschützte Mitglieder öffentlicher Klassen in die Ausgabe ein. Dies ist das
default.

-Paket
Schließen Sie öffentliche, geschützte und paketprivate Mitglieder von öffentlich und paketprivat ein
Klassen.

-Privat
Beziehen Sie alle Klassen und Klassenmitglieder ein, unabhängig von ihrer Zugriffsebene.

-Splitindex
Generieren Sie eine Indexseite pro Buchstabe anstelle einer einzelnen, monolithischen Indexseite.

Standardmäßig enthält der vom Standard-Doclet erstellte Index alle Einträge in einem einzigen
Seite. Dies ist für kleine Dokumentationssätze in Ordnung, bei großen Sätzen sollte dies jedoch der Fall sein
diese Option angeben.

-nosince
Ignore @schon seit Tags in Javadoc-Kommentaren.

Standardmäßig enthält die generierte Ausgabe Abschnitte, in denen die Version Ihrer API aufgeführt ist
seit wann das betreffende Paket, die betreffende Klasse oder das betreffende Klassenmitglied existiert, wenn dieses Tag vorhanden ist
angetroffen. Geben Sie diese Option an, um diese Informationen wegzulassen.

-notree
Erzeugen Sie keine Baumseiten.

Standardmäßig enthält die generierte Ausgabe einen Vererbungsbaum pro Paket und – falls
Der Dokumentationssatz besteht aus mehreren Paketen – einer Seite mit der vollständigen Vererbung
Baum. Geben Sie diese Option an, um die Generierung dieser Seiten zu unterlassen.

-noindex
Geben Sie den alphabetischen Index nicht aus.

Standardmäßig generiert gjdoc einen alphabetischen Index aller Programmelemente im
Dokumentationssatz (Pakete, Klassen, innere Klassen, Konstruktoren, Methoden usw.)
Felder). Geben Sie diese Option an, um diese Informationen wegzulassen.

-Keine Hilfe
Generieren Sie nicht die Hilfeseite.

Diese Option wird derzeit ignoriert, da das Standard-Doclet keine Hilfeseite bereitstellt.

-nodeprecated
Geben Sie keine Inline-Informationen über veraltete Pakete, Klassen oder Klassenmitglieder aus.

Standardmäßig fügt das Standard-Doclet einen hervorgehobenen Absatz mit veralteter Funktion hinzu
Informationen zur Beschreibung jedes veralteten Programmelements. Geben Sie dies an
Option, diese Informationen wegzulassen.

-nodeprecatedlist
Geben Sie die Zusammenfassungsseite für veraltete API-Elemente nicht aus.

Standardmäßig generiert das Standard-Doclet eine Seite mit einer Liste aller veralteten API-Elemente
zusammen mit einer Einstellungsbeschreibung, die normalerweise den Grund für die Einstellung enthält
und mögliche Alternativen. Geben Sie diese Option an, um diese Informationen wegzulassen.

-nonavbar
Geben Sie die Navigationsleiste, Kopf- und Fußzeile nicht aus.

Standardmäßig ist jede Ausgabeseite mit einer oberen Navigationsleiste ausgestattet (die Folgendes enthalten kann).
eine vom Benutzer angegebene Kopfzeile) und eine untere Navigationsleiste (die eine vom Benutzer angegebene Kopfzeile enthalten kann)
angegebene Fußzeile). Geben Sie diese Option an, um diese Dekoration wegzulassen.

-kein Kommentar
Lassen Sie den gesamten Dokumentationstext aus den generierten Dateien weg und geben Sie nur Deklarationen und aus
Programmelementbeziehungen.

Diese Option dient der Kompatibilität mit javadoc. Wenn Sie eine Extraktion planen
Informationen zu Ihrem Projekt über gjdoc, sollten Sie die Verwendung eines anderen Doclets in Betracht ziehen
für Ihre Zwecke verwenden, zum Beispiel XmlDoclet. Sie können auch die Doclet-API verwenden
direkt durch die Implementierung eines neuen Doclets.

-Linkquelle
Generieren Sie für jede Klasse eine Seite mit syntaxhervorgehobenem Quellcode. Standardmäßig ist dies der Fall
Seite wird nicht generiert.

Der Quellcode kann durch Klicken auf die Schaltfläche mit der Bezeichnung „Quelle“ im aufgerufen werden
Navigationsleiste oder durch Klicken auf den Namen eines Konstruktors, Felds, einer Methode oder eines Inners
Klasse im Detailabschnitt einer Klassendokumentationsseite.

-verwenden
Erstellen Sie eine Seite mit Querverweisinformationen. Standardmäßig ist dies bei dieser Seite nicht der Fall
generiert.

Die Querverweisinformationen können durch Klicken auf die Schaltfläche mit der Bezeichnung abgerufen werden
„Verwenden“ in der Navigationsleiste.

Auf der Seite „Verwenden“ werden alle Klassen/Schnittstellen im Dokumentationssatz aufgelistet
die betreffende Klasse (den betreffenden Typ) erweitern/implementieren; Felder des Typs; Methoden bzw
Konstruktoren, die einen Parameter des Typs akzeptieren; Methoden, die den Typ zurückgeben; Und
Methoden oder Konstruktoren, die den Typ auslösen.

-Autor
Fügen Sie Autoreninformationen in die Ausgabe ein.

Wenn angegeben, werden die Autoreninformationen wie unter Verwendung angegeben angegeben @Autor Tag in Javadoc
Kommentare werden in die Ausgabe integriert. Standardmäßig, @Autor Tags werden ignoriert.

-Ausführung
Fügen Sie Versionsinformationen in die Ausgabe ein.

Wenn angegeben, werden Versionsinformationen wie mit angegeben angegeben @Ausführung Tag in Javadoc
Kommentare werden in die Ausgabe integriert. Standardmäßig, @Ausführung Tags werden ignoriert.

-Lizenztext
Gehen Sie davon aus, dass der erste Kommentar in jeder Quelldatei den Lizenztext enthält, und fügen Sie ihn hinzu
Lizenzinformationen in die Fußzeile jeder generierten Klassenseite einfügen.

Dies ist eine spezifische Option für gjdoc und nicht kompatibel zu Sun javadoc.

Diese Option ist für die Verwendung mit kostenlosen und Open-Source-Projekten gedacht, in denen Quellcode enthalten ist
wird in der Regel ein vorgefertigter Lizenzkommentar vorangestellt, wenn rechtliche Gründe vorliegen
für die Aufnahme der Lizenz in die Dokumentation.

-docfilessubdirs
Kopieren Sie rekursiv alle Dateien in doc-Dateien Unterverzeichnis jedes Paketverzeichnisses.

Normalerweise werden nur die Dateien in der doc-Dateien Unterverzeichnisse werden ohne Abstieg kopiert
rekursiv.

-excludedocfilessubdir Name:Name: ...
Kopieren Sie einige Verzeichnisse nicht direkt darunter doc-Dateien Unterverzeichnisse wann
rekursiv absteigend.

Das Argument dieser Option sollte eine durch Doppelpunkte getrennte Liste von Verzeichnisnamen sein.

Diese Option ist nur sinnvoll, wenn -docfilessubdirs ist ebenfalls angegeben. In diesem Fall jeder
Unterverzeichnis direkt unter a doc-Dateien Das Verzeichnis wird weggelassen, wenn es aufgeführt ist.

Maßgeschneidert Dokumentation Schlüsselwörter

-tagletpath Pfadliste
Suche Pfadliste beim Laden nachfolgender Taglet-Klassen, die mit angegeben werden -taglet.

Pfadliste sollte ein oder mehrere Pfade zu einem Verzeichnis oder einer JAR-Datei sein, getrennt durch Ihr
Pfadtrenner der Plattform (normalerweise : or ;).

-taglet Klassenname
Registrieren Sie ein Taglet.

Klassenname sollte der vollständig qualifizierte Name einer Java-Klasse sein, die implementiert
com.sun.tools.doclets.Taglet.

Die Taglet-Klassen werden aus dem mit angegebenen Klassenpfad geladen -tagletpath, von
Der mit angegebene Klassenpfad -Klassenpfad und aus dem Standardklassenpfad.

Siehe die Dokumentation von com.sun.tools.doclets.Taglet und fordern Sie weitere Informationen an.

Beachten Sie, dass dies auch für einfache Tags der Fall ist -Etikett.

-Etikett Tagsspez
Registrieren Sie ein generisches Taglet.

Das Format von Tagsspez muß : :" ".

Verlinke den Namen ist der zu vergleichende Tag-Name ohne das führende @-Zeichen.

Fahnen ist eines oder mehrere der folgenden Zeichen, wobei jedes Zeichen ein angibt
Quellcode-Kontext, in dem das Tag erkannt werden soll.

a alle Kontexte

c Konstruktoren

f Felder

m Methoden

o Überblick

p Pakete

t Typen (Klassen, Schnittstellen, Ausnahmen, Fehler)

X Sonderzeichen, das das Taglet vorübergehend vollständig deaktiviert.

Schlagwort ist die Zeichenfolge, die in der Kopfzeile des Abschnitts angezeigt werden soll, der dem Tag gewidmet ist
Frage.

Zum Beispiel, um einen Tag-Abgleich zu definieren @cvsid was im Überblick zu akzeptieren ist,
Paket- und Typseiten und ist mit der Kopfzeile gekennzeichnet CVS ID, du würdest
angeben:

-tag cvsid:tpo:"CVS-ID"

Nehmen wir an, dass eine Klasse einen Javadoc-Kommentar enthält

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

Dann enthält die HTML-Ausgabe so etwas wie

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

Laufen Andere Doclets

-docletpath Pfadliste
Suche Pfadliste beim Laden von Klassen für das mit angegebene Doclet -doclet.

Pfadliste sollte ein oder mehrere Pfade zu einem Verzeichnis oder einer JAR-Datei sein, getrennt durch Ihr
Pfadtrenner der Plattform (normalerweise : or ;).

-doclet Klassenname
Führen Sie das angegebene Doclet anstelle des standardmäßigen HtmlDoclet aus.

Klassenname sollte der vollständig qualifizierte Name einer Klasse sein, die über einen öffentlichen Standard verfügt
Konstruktor und enthalten eine Methode mit der folgenden Signatur:

import com.sun.javadoc.RootDoc;
öffentlicher statischer boolescher Start (RootDoc ​​rootDoc)

Die Doclet-Klassen werden aus dem mit angegebenen Klassenpfad geladen -docletpath, von
Der mit angegebene Klassenpfad -Klassenpfad und aus dem Standardklassenpfad.

Das Anfang Die Methode sollte die von der Doclet-API bereitgestellten Informationen verarbeiten rootDoc
und zurück was immer dies auch sein sollte. auf Erfolg, falsch bei Ausfall.

Wenn Sie ein Doclet eines Drittanbieters verwenden, finden Sie weitere Informationen in der zugehörigen Dokumentation
Anweisungen. Beachten Sie, dass die Unterstützung für Doclets von Drittanbietern experimentell ist. Bitte
Melden Sie alle Probleme, auf die Sie stoßen, oder geben Sie bei erfolgreicher Ausführung Feedback
Applets von Drittanbietern.

Diese Option kann mehrmals angegeben werden. In diesem Fall werden alle Doclets ausgeführt
mit demselben Informationsbaum, der über die Doclet-API für jede Doclet-Ausführung bereitgestellt wird.

Hinzufügen Informationen zu Output

-Fenstertitel Text
Verwenden Sie die Text als Titelpräfix des Browserfensters.

Wenn angegeben, wird dem Titel des Browserfensters für jede Seite ein Präfix vorangestellt Text
anstelle der Standardzeichenfolge API Dokumentation.

Text sollte aus reinem Text bestehen (er sollte keine HTML-Tags enthalten).

-doctitle Text
Setzen Sie den Kopftext der Übersichtsseite auf Text.

Text sollte eine kurze Klartextzeichenfolge sein.

Beim Generieren der Dokumentation für ein einzelnes Paket wird durch die Angabe dieser Option erzwungen
Generierung der Übersichtsseite.

-Header htmltext
Speichern htmltext in der rechten oberen Ecke jeder generierten Seite. htmltext gewöhnlich
auf den Namen des Projekts gesetzt, das dokumentiert wird.

-Fusszeile htmltext
Speichern htmltext in der rechten unteren Ecke jeder generierten Seite. htmltext Oft ist
auf den gleichen Wert wie für gesetzt -Header.

-Unterseite htmltext
Speichern htmltext bis ganz unten auf jeder generierten Seite und erstreckt sich über die gesamte Breite von
die Seite. Wenn angegeben, htmltext besteht in der Regel aus einem Urheberrechtsvermerk und/oder
Links zu anderen Projektseiten.

-addstylesheet Datei
Erweitern Sie die Standard-CSS-Stylesheets mit dem benutzerdefinierten Stylesheet Datei.

Das angegebene Stylesheet wird einfach von jeder HTML-Seite zusätzlich zum Standard geladen
ones, als letztes Stylesheet.

Beachten Sie, dass die CSS-Kaskadierungsregeln gelten. Das heißt, Ihre Stileigenschaften werden nur sein
zugewiesen, wenn sie eine höhere Kaskadenordnung haben als gjdocist der Standardstil. Eine einfache
Um sicherzustellen, dass dies der Fall ist, müssen Sie Ihre Außerkraftsetzungen deklarieren ! important.

Sehenhttp://www.w3.org/TR/REC-CSS2/cascade.html#cascading-order>.

-Gruppe Üerschrift pkgwildcard:pkgwildcard: ...
Ordnen Sie die angegebenen Pakete in einer separaten Gruppe auf der Übersichtsseite an.

Das erste Argument sollte ein kurzer Klartext sein, der als Titel des verwendet wird
Paketgruppe. Das zweite Argument sollte eine durch Doppelpunkte getrennte Paketliste sein
Platzhalter. Die Gruppe besteht aus allen Paketen im Dokumentationssatz, deren Namen
entspricht einem der angegebenen Platzhalter.

Es gibt nur ein Platzhalterzeichen, *, das mit beiden Buchstaben im Paketnamen übereinstimmt
Komponenten und die . Trennung der Paketnamensbestandteile. Zum Beispiel, j*regex würde
Match-Paket java.util.regex. Ein nützlicheres Beispiel wäre javax.swing* zu entsprechen
javax.swing und alle seine Unterpakete.

Diese Option kann mehrfach angegeben werden.

FIXME: Informationen zur Gruppenverschachtelung hier.

gjdoc -group "Kernklassen" 'java*' \
-group "Swing" 'javax.swing*' \
-group "XML APIs" 'javax.xml*' \
-group „Andere Erweiterungen“ javax* \
...

-Überblick Datei
Fügen Sie das XHTML-Körperfragment von hinzu Datei zur Übersichtsseite.

Datei sollte ein XHTML-Fragment mit dem HTML enthalten Körper Tag als Wurzelknoten.

Mit dieser Option kann eine Beschreibung des gesamten Dokumentationssatzes bereitgestellt werden.

Bei Angabe wird der erste Satz des Fragments über den Tabellen platziert
Auflistung der dokumentierten Pakete, zusammen mit einem Link zur vollständigen Kopie des Fragments
welches unterhalb der Tabellen steht.

Beim Generieren der Dokumentation für ein einzelnes Paket wird durch die Angabe dieser Option erzwungen
Generierung der Übersichtsseite.

-stylesheetfile Datei
Verwenden Sie das CSS-Stylesheet in Datei anstelle der Standard-CSS-Stylesheets.

Wenn Sie nur Teile der Standard-Stylesheets überschreiben möchten, verwenden Sie -addstylesheet
stattdessen.

-Titel Text
Veraltet. Verwenden Sie die -doctitle Text stattdessen.

-Hilfedatei Datei
Diese Option wird derzeit ignoriert.

Bei der Implementierung wird das XHTML-Fragment in verwendet Datei für den Inhalt der Hilfeseite
anstelle des Standard-Hilfetextes.

Regelung Ausgabe.

-d Verzeichnis
Platzieren Sie alle Ausgabedateien in Verzeichnis (und Unterverzeichnisse). Verzeichnis wird erstellt
falls nicht vorhanden, einschließlich aller nicht vorhandenen übergeordneten Verzeichnisse und aller erforderlichen
Unterverzeichnisse.

Wenn nicht angegeben, wird die Ausgabe im aktuellen Verzeichnis abgelegt.

-Gebietsschema Name
Verwenden Sie das Gebietsschema Name anstelle des Standardgebietsschemas für alle Zwecke.

Name sollte ein Gebietsschemaspezifizierer im Formular sein ll_CC[_VAR] woher ll ist ein kleiner Zwei-
Buchstabe ISO-639-Sprachcode, CC ist ein optionales ISO-3166-Land aus zwei Großbuchstaben
Code, und VAR ist ein optionaler Variantencode. Zum Beispiel, en spezifiziert Englisch, en_US
gibt US-Englisch an und de_US_WIN spezifiziert eine abweichende Variante des US-Englischen
lokal.

Beachten Sie, dass die Semantik dieser Option genau der der Konstruktoren entspricht
der Klasse java.util.Locale.

Diese Option bestimmt derzeit nur, welcher Collator zum Sortieren der Ausgabe verwendet wird
Elemente. Das bedeutet, dass das Gebietsschema nur dann eine Auswirkung hat, wenn Sie Nicht-Sprache verwenden.
ASCII-Zeichen in Bezeichnern.

-Zeichensatz charset
Veraltet. Überschreiben Sie die angegebene Codierung in XHTML-Ausgabedateien mit der angegebenen
by charset.

Wenn diese Option nicht angegeben ist, wird die Codierungsspezifikation im Ausgabe-XHTML ausgewählt
mit der Kodierung übereinstimmen, die beim Schreiben der Datei verwendet wurde (die mit angegebene Kodierung). -Dokumentenkodierung,
oder die Standardkodierung Ihrer Plattform).

Die Semantik für charset sind hier angegeben:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. Aus praktischen Gründen gilt:
Sie sind identisch mit denen der anderen Optionen, die Zeichensatzparameter akzeptieren.

Diese Option dient der Kompatibilität mit javadoc und sollte vermieden werden.

-Dokumentenkodierung charset
Verwenden Sie beim Schreiben von Ausgabedateien die angegebene Zeichensatzkodierung anstelle der Ihrer Plattform
Standardkodierung.

Beispiele für charset sind US-ASCII, ISO-8859-1 or UTF-8.

Die Semantik dieser Option entspricht genau der der Konstruktoren der Klasse
java.util.Locale.

-validhtml
Erzwingen Sie die Generierung von gültigem XHTML-Code. Dadurch wird die Kompatibilität zum Traditionellen unterbrochen
Teilweise ein Javadoc-Tool.

Wenn diese Option angegeben ist, werden Ankernamen entstellt, sodass sie gültig sind
gemäß der XHTML 1.1-Spezifikation. Allerdings wird ein Dokumentationssatz mit generiert
Diese Option kann mit dem herkömmlichen Javadoc-Tool nicht ordnungsgemäß verknüpft werden. Es kann
lässt sich jedoch problemlos mit Gjdoc verlinken.

Ohne diese Option verwenden Ankernamen für ausführbare Klassenmitglieder das Traditionelle
Format, zum Beispiel: „foo(String,int[])“. Dies ist mit dem Traditionellen kompatibel
Javadoc-Tool, aber gemäß den Spezifikationen HTML 4.0 und XHTML 1.0 und 1.1,
Dieses Format enthält illegale Zeichen. Klammern, eckige Klammern und das Komma
sind in Ankernamen nicht zulässig.

-baseurl URL
Verdrahten Sie eine Seiten-URL relativ zu URL in jede generierte Seite.

Wenn Sie Dokumentation erstellen, die ausschließlich zu einem bestimmten Zeitpunkt verfügbar ist
URL, Sie sollten diese Option verwenden, um diese URL anzugeben.

Dies kann dazu beitragen, bestimmte Weiterleitungsangriffe von Spammern zu vermeiden, und es kann hilfreich sein
für bestimmte Web-Clients.

Ausführlichkeit Optionen

-ruhig
Unterdrücken Sie alle Ausgaben außer Warnungen und Fehlermeldungen.

-verbose
Seien Sie sehr ausführlich darüber, was gjdoc macht.

Diese Option wird derzeit ignoriert.

Assistent Maschine Optionen

Sonne javadoc Tool scheint darauf zu basieren Javak und als solches scheint es auf der VM zu funktionieren
Ebene. gjdocIm Gegensatz dazu handelt es sich um eine reine Java-Anwendung.

Daher sind gjdoc kann die folgenden Optionen auf VM-Ebene nur vortäuschen oder simulieren.

-Klassenpfad Pfadliste
Legen Sie die virtuelle Maschine fest Klassenpfad zu Pfadliste.

In den meisten Fällen sollten Sie verwenden -docletpath or -tagletpath anstelle dieser Option.

Pfadliste sollte ein oder mehrere Pfade zu einem Verzeichnis oder einer JAR-Datei sein, getrennt durch Ihr
Pfadtrenner der Plattform (normalerweise : or ;).

Wenn diese Option nicht auf Wrapper-Ebene abgefangen wird, gjdoc Derzeit fälscht es von
Aufruf System.setProperty("java.class.path", Pfadliste); und gibt eine Warnung aus.

-bootclasspath Pfadliste
Legen Sie die virtuelle Maschine fest Bootklassenpfad zu Pfadliste.

Wenn diese Option nicht auf Wrapper-Ebene abgefangen wird, gjdoc gibt eine Warnung aus.

-Jvmopt
Übergeben Sie einen beliebigen Parameter an die virtuelle Maschine gjdoc läuft auf.

Wenn diese Option nicht auf Wrapper-Ebene abgefangen wird, gjdoc versucht das zu emulieren
Option und gibt eine Warnung aus.

Derzeit nur die VM-Option -D zum Festlegen von Systemeigenschaften wird emuliert.

Verwenden Sie gjdoc-4.8 online über die Dienste von onworks.net