gjdoc-4.8 - Online in de cloud

PROGRAMMA:

NAAM

cp-tools - GNU Classpath Tools-gids

KORTE INHOUD

gjdoc [-bronpad padlijst]
[-allemaal] [-subpakketten pkg:pkg:...] [-uitsluiten pkglijst]
[-codering karakterset] [-plaats naam] [-source los]
[-openbaar] [-beschermd] [-pakket] [-privaat]
[-doctitel tekst] [-koptekst tekst] [-voettekst tekst] [-bodem tekst]
[-koppeling url] [-offlinelinken url pad] [-geen kwalificatie pkg:pkg:...]
[-tagletpad padlijst] [-label naam van de klasse] [-label tagspecificatie]
[-gebruik] [-linkbron] [-splitindex] [-geenindex] [-geenboom]
[-versie] [-auteur] [-neus] [-stijlblad toevoegen filet]
[-d doelmap]
[Paketten ...] [bronbestanden...] [@cmd-bestand]

gjdoc [-bronpad padlijst]
[-allemaal] [-subpakketten pkg:pkg:...] [-uitsluiten pkglijst]
[-codering karakterset] [-plaats naam] [-source los]
[-openbaar] [-beschermd] [-pakket] [-privaat]
[-docletpad padlijst] [-doclet naam van de klasse]
[Paketten ...] [bronbestanden...] [@cmd-bestand]
[doclet opties]

gjdoc --help

gjdoc --versie

Alleen de meest bruikbare opties worden hier vermeld; zie hieronder voor de rest.

PRODUCTBESCHRIJVING

Gjdoc kan op twee manieren worden gebruikt: als een stand-alone documentatietool of als stuurprogramma voor een
door de gebruiker gespecificeerde Doclet.

In de standaardmodus gebruikt Gjdoc de standaard Doclet HtmlDoclet om een ​​set van te genereren
HTML-pagina's. Het canonieke gebruik is:

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

Hier src/java/ is de root van uw broncodeklassenhiërarchie, -allemaal betekent dat alle geldige
Java-bestanden die in deze hoofdmap worden gevonden, moeten worden verwerkt, en API-docs/ is de
directory waar de gegenereerde documentatie moet worden geplaatst.

Raadpleeg de handleiding voor meer informatie over het uitvoeren van andere doclets dan de standaarddoclet.

OPTIES

Keuze Samengevat by Type

Hier is een overzicht van alle opties van zowel Gjdoc als de Standard Doclet, gegroepeerd op
type. Uitleg vindt u in de volgende secties.

bron Zet de Opties
-bronpad padlijst -subpakketten pkglijst -uitsluiten pkglijst

bron Formaat Opties
-source los -codering codering -breker

Onderling verbinden Opties
-koppeling url -offlinelinken url filet -geen kwalificatie pkg:pkg:...

Generatie Opties
-auteur -licentietekst -gebruik -versie -splitindex -geenindex
- niet verouderd -nodeafgeschafte lijst -geen hulp -nonavbar
-neus -geenboom -openbaar -beschermd -pakket -privaat
-docfilessubmappen -excludedocfilessubmap zeg eens
-linkbron

uitgang Opties
-d -plaats naam -tekenset karakterset -docencodering karakterset
-geldigehtml -basisurl url

Decoratie Opties
-venstertitel tekst -doctitel tekst -titel tekst
-koptekst tekst -voettekst tekst -bodem tekst
-helpbestand filet -stylesheetbestand filet -stijlblad toevoegen filet
-groep groepskop pkgpatroon:pkgpatroon:...

Taglet Opties
-tagletpad -label naam van de klasse -label tagspecificatie

doclet Opties
-docletpad -doclet naam van de klasse

Breedsprakigheid Opties
-rustig -uitgebreid

Virtueel Machine Opties
-klassenpad -bootklassepad -J vmopt

Selecteren welke bron Bestanden naar Proces

-s padlijst
-bronpad padlijst
Zoek naar bronbestanden in de opgegeven map of mappen.

padlijst moet een of meer mappaden zijn, gescheiden door het pad van uw platform
scheidingsteken (meestal : or ;).

Als deze optie niet wordt gegeven, gjdoc zoekt naar bronbestanden in de huidige
directory.

De opgegeven mappen moeten hoofdmappen zijn in termen van het Java-pakket
systeem. Als u bijvoorbeeld documentatie wilt genereren voor klassen in package
foo.bar, moet u de map met het hoogste niveau opgeven foo submap,
niet de directory foo/bar/ waarin de Java-bronbestanden zich bevinden.

De afkorting alias -s is specifiek voor gjdoc en niet compatibel met Sun javadoc.

-allemaal
[EXPERIMENTEEL] Verwerk alle geldige Java-bronbestanden die zijn gevonden in de mappen die worden vermeld in
het bronpad en hun submappen.

Dit is een optie die specifiek is voor: gjdoc en niet compatibel met Sun javadoc.

-subpakketten pkg:pkg:...
Verwerk de klassen in de gegeven Java-pakketten en alle subpakketten recursief.
Merk op dat meerdere pakketnamen gescheiden moeten worden door dubbele punten in plaats van spaties.

-uitsluiten pkg:pkg:...
Verwerk geen klassen in de gegeven Java-pakketten en alle subpakketten, recursief.
Deze optie kan worden gebruikt in combinatie met: -allemaal or -subpakketten om uit te sluiten
individuele pakketten of pakketsubstructuren uit de uitvoer.

Paketten ...
Verwerk alle klassen in de gegeven Java-pakketten.

bronbestanden...
Verwerk de klassen in de gegeven Java-bronbestanden.

opgeven de Formaat of Invoer Bestanden

-source los
Neem aan dat de bronbestanden zijn gericht op de gegeven release van het Java-platform.

los moet het versienummer zijn van een Java-platformrelease in de indeling
MAJOR.MINOR, bijvoorbeeld 1.4.

Deze optie wordt momenteel genegeerd, behalve dat er een fout optreedt als een releasenummer
dan 1.2, 1.3 or 1.4 is gespecificeerd.

-codering karakterset
Neem aan dat de bronbestanden zijn gecodeerd met karakterset.

Voorbeelden voor karakterset zijn US-ASCII, ISO-8859-1 or UTF-8.

De semantiek van karakterset zijn identiek aan die van
java.nio.charset.Charset.forName(String).

-breker
Gebruik java.text.BreakIterator van de landinstelling in plaats van de interne eerste zin
detector.

Standaard gjdoc gebruikt een intern algoritme om te bepalen waar een zin eindigt. Wanneer
deze optie is gegeven, zal het in plaats daarvan de . gebruiken java.tekst.BreakIterator bijvoorbeeld voor de
locale gegeven met -plaats (of de standaardlandinstelling).

Deze optie moet worden opgegeven bij het aanvragen gjdoc broncode becommentarieerd in een niet-
latijnse taal waarvoor de standaard eerstezinsdetector niet werkt. Voor iedereen
in andere gevallen levert de standaard (gebruik BreakIterator niet) betere resultaten op bij de
tijd van dit schrijven.

Onderling verbinden Met anders Documentatie Sets

-koppeling url
Maak hyperlinks naar een andere documentatieset.

Standaard gjdoc maakt alleen hyperlinks naar klassen in de bronset. Gebruik dit
optie om extra hyperlinks te maken naar klassen die onder de gespecificeerde vallen
documentatie set.

url moet de root-URL zijn van de andere documentatieset. Om bijvoorbeeld toe te voegen
hyperlinks naar GNU Classpath, specificeer het volgende:

-koppeling http://developer.classpath.org/doc/

De -koppeling optie kan meerdere keren worden opgegeven.

Merk op dat het specificeren van de -koppeling optie zal een HTTP-toegang veroorzaken elke keer dat gjdoc is
ingeroepen. Je kunt gebruiken -offlinelinken in plaats daarvan om deze toegang te vermijden.

-offlinelinken url filet
Maak hyperlinks naar een andere documentatieset die ook aanwezig is in het lokale bestand
systeem.

Deze optie werkt precies zoals -koppeling, behalve dat het toegang heeft tot het lokale bestandssysteem
in plaats van het netwerk om te bepalen welke klassen vallen onder de gekoppelde
documentatie set.

Tijdens gebruik -offlinelinken de externe documentatieset is helemaal niet toegankelijk, wat kan
de generatietijd aanzienlijk versnellen, afhankelijk van uw netwerkverbinding. De
gegenereerde hyperlinks naar de documentatieset verwijzen echter naar de externe set, niet naar
de lokale, zodat u de documentatie zonder verder kunt verspreiden
afhankelijkheden.

De -offlinelinken optie kan meerdere keren worden opgegeven.

-geen kwalificatie pkg:pkg:...
Kwalificeer namen van klassen in de gegeven pakketten niet met hun pakketnaam.

Standaard wordt een klassenaam alleen ongekwalificeerd weergegeven als de klasse deel uitmaakt van de
bronset of een gekoppelde documentatieset, en gekwalificeerd met de naam van zijn
met pakket als dit niet het geval is. U kunt deze optie gebruiken om ongekwalificeerde namen te forceren
voor klassen, zelfs als ze geen deel uitmaken van de documentatieset.

Gewoonlijk wordt een verwijzing naar de klasse String bijvoorbeeld volledig gekwalificeerd weergegeven als
java.lang.String (tenzij u naar de juiste documentatieset linkt met -koppeling)
omdat het geen deel uitmaakt van de documentatieset. U kunt specificeren: -geen kwalificatie
java lang om dezelfde verwijzingen weer te geven als Draad.

Houd er rekening mee dat voor alle niet-gekwalificeerde klassennamen een tooltip wordt gegeven wanneer u uw . plaatst
muisaanwijzer erop in de HTML-documentatie.

-geen kwalificatie allen
Laat pakketnaamkwalificatie weg uit alle klassenamen.

Specificeer deze optie om pakketnaamkwalificaties helemaal weg te laten,

Selecteren welke Informatie naar Genereer

-openbaar
Neem alleen openbare leden van openbare klassen op in de uitvoer. Standaard beveiligd
klasleden zijn ook inbegrepen.

-beschermd
Neem openbare of beschermde leden van openbare klassen op in de uitvoer. Dit is de
standaard.

-pakket
Publieke, beschermde en pakket-private leden van openbaar en pakket-privé opnemen
klassen.

-privaat
Neem alle klassen en klasleden op, ongeacht hun toegangsniveau.

-splitindex
Genereer één indexpagina per letter in plaats van één monolithische indexpagina.

Standaard bevat de index die is gemaakt door de Standard Doclet alle vermeldingen op een enkele
bladzijde. Dit is prima voor kleine documentatiesets, maar voor grote sets moet u:
specificeer deze optie.

-neus
negeren @sinds tags in javadoc-opmerkingen.

Standaard bevat de gegenereerde uitvoer secties met de versie van uw API
sinds welke het pakket, de klas of het klaslid in kwestie bestaat wanneer deze tag is
tegengekomen. Geef deze optie op om deze informatie weg te laten.

-geenboom
Genereer geen boompagina's.

Standaard bevat de gegenereerde uitvoer één overervingsboom per pakket, en - als
de documentatieset bestaat uit meerdere pakketten - een pagina met de volledige erfenis
boom. Specificeer deze optie om het genereren van deze pagina's weg te laten.

-geenindex
Voer de alfabetische index niet uit.

gjdoc genereert standaard een alfabetische index van alle programma-elementen in de
documentatieset (pakketten, klassen, innerlijke klassen, constructors, methoden en
velden). Geef deze optie op om deze informatie weg te laten.

-geen hulp
Genereer de helppagina niet.

Deze optie wordt momenteel genegeerd omdat de standaarddoclet geen helppagina biedt.

- niet verouderd
Voer geen inline informatie uit over verouderde pakketten, klassen of klasleden.

Standaard voegt de Standard Doclet een gemarkeerde alinea toe met afschrijving
informatie naar de beschrijving van elk verouderd programma-element. Specificeer dit
optie om deze informatie weg te laten.

-nodeafgeschafte lijst
Voer de overzichtspagina niet uit voor verouderde API-elementen.

Standaard genereert de Standard Doclet een pagina met alle verouderde API-elementen
samen met een beschrijving van de beëindiging die meestal de reden voor de beëindiging bevat
en mogelijke alternatieven. Geef deze optie op om deze informatie weg te laten.

-nonavbar
Voer de navigatiebalk, koptekst en voettekst niet uit.

Elke uitvoerpagina is standaard uitgerust met een navigatiebalk bovenaan (die kan bevatten:
een door de gebruiker gespecificeerde kop) en een navigatiebalk onderaan (die een gebruikers-
gespecificeerde voettekst). Specificeer deze optie om deze decoratie weg te laten.

-geen commentaar
Laat alle documentatietekst uit de gegenereerde bestanden weg en voer alleen declaraties uit en
programma-element relaties.

Deze optie is hier voor compatibiliteit met: javadoc. Als u van plan bent om te extraheren
informatie over uw project via gjdoc, kunt u overwegen een andere Doclet te gebruiken
voor uw doeleinden, bijvoorbeeld XmlDoclet. Je zou ook de Doclet API kunnen gebruiken
rechtstreeks door een nieuwe Doclet te implementeren.

-linkbron
Genereer een pagina met syntaxis-gemarkeerde broncode voor elke klasse. Standaard is dit
pagina wordt niet gegenereerd.

De broncode is toegankelijk door te klikken op de knop met het label "Bron" in de
navigatiebalk, of door te klikken op de naam van een constructor, veld, methode of inner
class in de detailsectie van een class-documentatiepagina.

-gebruik
Genereer een pagina met informatie over kruisverwijzingen. Standaard is deze pagina niet
gegenereerd.

De kruisverwijzingsinformatie is toegankelijk door te klikken op de knop met het label
'Gebruik' in de navigatiebalk.

De `Gebruik'-pagina vermeldt alle klassen/interfaces in de documentatieset die
de betreffende klasse (type) uitbreiden/implementeren; velden van het type; methoden of
constructeurs die een parameter van het type accepteren; methoden die het type retourneren; en
methoden of constructors die het type gooien.

-auteur
Voeg auteursinformatie toe aan de uitvoer.

Indien gespecificeerd, auteursinformatie zoals gespecificeerd met de @auteur taggen in javadoc
opmerkingen worden verwerkt in de output. Standaard, @auteur tags worden genegeerd.

-versie
Neem versie-informatie op in de uitvoer.

Indien gespecificeerd, versie-informatie zoals gespecificeerd met de @versie taggen in javadoc
opmerkingen worden verwerkt in de output. Standaard, @versie tags worden genegeerd.

-licentietekst
Neem aan dat de eerste opmerking in elk bronbestand de licentietekst bevat, en voeg toe
licentie-informatie naar de voettekst van elke gegenereerde klaspagina.

Dit is een optie die specifiek is voor: gjdoc en niet compatibel met Sun javadoc.

Deze optie is bedoeld voor gebruik met gratis en open source-projecten waarbij de broncode
wordt meestal voorafgegaan door een commentaar op een standaardlicentie, wanneer er juridische redenen zijn
voor het opnemen van de licentie in de documentatie.

-docfilessubmappen
Kopieer recursief alle bestanden in de doc-bestanden submap van elke pakketmap.

Gewoonlijk worden alleen de bestanden in de doc-bestanden submap worden gekopieerd zonder aflopend
recursief.

-excludedocfilessubmap naam:naam: ...
Kopieer sommige mappen niet direct onder de doc-bestanden submappen wanneer
recursief dalend.

Het argument voor deze optie moet een door dubbele punten gescheiden lijst met mapnamen zijn.

Deze optie heeft alleen zin als -docfilessubmappen staat ook vermeld. In dit geval is elke
submap die zich direct onder a . bevindt doc-bestanden directory wordt weggelaten als deze wordt vermeld.

Eigen Documentatie Tags

-tagletpad padlijst
Ontdek padlijst bij het laden van volgende Taglet-klassen gespecificeerd met -label.

padlijst moet een of meer paden zijn naar een map of jar-bestand, gescheiden door uw
padscheidingsteken van het platform (meestal : or ;).

-label naam van de klasse
Registreer een Taglet.

naam van de klasse moet de volledig gekwalificeerde naam zijn van een Java-klasse die implementeert
com.sun.tools.doclets.Taglet.

De Taglet-klassen worden geladen vanuit het klassenpad dat is opgegeven met -tagletpad, van
het klassenpad gespecificeerd met behulp van -klassenpad en van het standaard klassenpad.

Zie de documentatie van com.sun.tools.doclets.Taglet te bezoeken voor meer informatie.

Merk op dat er voor eenvoudige tags ook: -label.

-label tagspecificatie
Registreer een generieke Taglet.

Het formaat van tagspecificatie moet : :" ".

tagnaam is de tagnaam die overeenkomt, zonder het leidende @-teken.

vlaggen is een of meer van de volgende tekens, waarbij elk teken a . aangeeft
broncodecontext waarin de tag moet worden herkend.

a alle contexten

c constructeurs

f velden

m methoden

o overzicht

p Paketten

t typen (klassen, interfaces, uitzonderingen, fouten)

X speciaal teken dat de Taglet tijdelijk helemaal uitschakelt.

tagkop is de tekenreeks die moet worden weergegeven in de kop van de sectie die is gewijd aan de tag in
vraag.

Om bijvoorbeeld een tag-overeenkomst te definiëren: @cvsid die in het overzicht moet worden aanvaard,
pakket- en typepagina's en die is gelabeld met de koptekst CVS ID, je zou
specificeren:

-tag cvsid:tpo:"CVS-ID"

Laten we zeggen dat een klasse javadoc-opmerking bevat:

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

Dan zal de HTML-uitvoer iets bevatten als:

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

Hardlopen Overige doclets

-docletpad padlijst
Ontdek padlijst bij het laden van klassen voor de Doclet die is opgegeven met -doclet.

padlijst moet een of meer paden zijn naar een map of jar-bestand, gescheiden door uw
padscheidingsteken van het platform (meestal : or ;).

-doclet naam van de klasse
Voer de opgegeven doclet uit in plaats van de standaard HtmlDoclet.

naam van de klasse moet de volledig gekwalificeerde naam zijn van een klasse met een openbare standaard
constructor en bevatten een methode met de volgende handtekening:

importeer com.sun.javadoc.RootDoc;
openbare statische boolean start (RootDoc ​​rootDoc)

De Doclet-klassen worden geladen vanuit het klassenpad dat is opgegeven met -docletpad, van
het klassenpad gespecificeerd met behulp van -klassenpad en van het standaard klassenpad.

De begin methode moet de informatie verwerken die wordt weergegeven door de Doclet API via rootDoc
En terugkomen waar op succes, vals op mislukking.

Als u een doclet van derden gebruikt, raadpleegt u de bijbehorende documentatie voor meer
instructies. Houd er rekening mee dat ondersteuning voor doclets van derden experimenteel is. Alsjeblieft
meld eventuele problemen die u tegenkomt, of geef feedback wanneer het succesvol is uitgevoerd
applets van derden.

Deze optie kan meerdere keren worden opgegeven, in welk geval alle doclets worden uitgevoerd
met dezelfde informatieboom die wordt weergegeven via de Doclet-API voor elke Doclet-run.

Het toevoegen van Informatie naar de uitgang

-venstertitel tekst
Te gebruiken tekst als de titelprefix van het browservenster.

Indien opgegeven, wordt de titel van het browservenster voor elke pagina voorafgegaan door: tekst
in plaats van de standaardreeks Vernieuwd API Documentatie.

tekst moet platte tekst zijn (het mag geen HTML-tags bevatten).

-doctitel tekst
Zet de koptekst van de overzichtspagina op tekst.

tekst moet een korte tekenreeks voor platte tekst zijn.

Bij het genereren van documentatie voor een enkel pakket, dwingt het specificeren van deze optie
generatie van de overzichtspagina.

-koptekst htmltekst
Toevoegen htmltekst naar de rechterbovenhoek van elke gegenereerde pagina. htmltekst gewoonlijk
ingesteld op de naam van het project dat wordt gedocumenteerd.

-voettekst htmltekst
Toevoegen htmltekst naar de rechterbenedenhoek van elke gegenereerde pagina. htmltekst vaak
ingesteld op dezelfde waarde als voor -koptekst.

-bodem htmltekst
Toevoegen htmltekst helemaal onderaan elke gegenereerde pagina, over de hele breedte van
de pagina. Wanneer gespecificeerd, htmltekst bestaat meestal uit een copyrightvermelding en/of
links naar andere projectpagina's.

-stijlblad toevoegen filet
Breid de standaard CSS-stijlbladen uit met het door de gebruiker gespecificeerde stijlblad filet.

De gegeven stylesheet wordt eenvoudigweg door elke HTML-pagina geladen naast de standaard
degenen, als de laatste stylesheet.

Merk op dat de CSS-cascaderegels van toepassing zijn. Dat wil zeggen, uw stijleigenschappen zijn alleen:
toegewezen als ze een hogere trapsgewijze volgorde hebben dan gjdoc's standaard stijl. een simpele
manier om ervoor te zorgen dat dit het geval is, is door uw overschrijvingen te declareren ! important.

Zienhttp://www.w3.org/TR/REC-CSS2/cascade.html#cascadering>.

-groep rubriek pkgwildcard:pkgwildcard: ...
Schik de gegeven pakketten in een aparte groep op de overzichtspagina.

Het eerste argument moet een korte platte tekst zijn die wordt gebruikt als de titel van de
pakket groep. Het tweede argument moet een door dubbele punten gescheiden lijst van pakketten zijn
wildcards. De groep zal bestaan ​​uit alle pakketten in de documentatieset waarvan de naam
komt overeen met een van de opgegeven jokertekens.

Er is slechts één jokerteken, *, die overeenkomt met beide letters in de pakketnaam
componenten en de . het scheiden van pakketnaamcomponenten. Bijvoorbeeld, j*regex zou
match pakket java.util.regex. Een nuttiger voorbeeld zou zijn: javax.schommel* bijpassende
javax.swing en al zijn subpakketten.

Deze optie kan meerdere keren worden gegeven.

FIXME: Informatie over groepsnesten hier.

gjdoc -groep "Kernklassen" 'java*' \
-groep "Swing" 'javax.swing*' \
-groep "XML API's" 'javax.xml*' \
-groep "Andere extensies" javax* \
...

-Overzicht filet
Voeg het XHTML-lichaamsfragment toe van filet naar de overzichtspagina.

filet moet een XHTML-fragment bevatten met de HTML lichaam tag als het hoofdknooppunt.

Deze optie kan worden gebruikt om een ​​beschrijving van de documentatieset als geheel te geven.

Indien gespecificeerd, wordt de eerste zin van het fragment boven de tabellen geplaatst
een lijst van de gedocumenteerde pakketten, samen met een link naar de volledige kopie van het fragment
die onder de tabellen wordt geplaatst.

Bij het genereren van documentatie voor een enkel pakket, dwingt het specificeren van deze optie
generatie van de overzichtspagina.

-stylesheetbestand filet
Gebruik de CSS-stylesheet in filet in plaats van de standaard CSS-stylesheets.

Als u alleen delen van de standaard stylesheets wilt overschrijven, gebruik -stijlblad toevoegen
gebruiken.

-titel tekst
Verouderd. Te gebruiken -doctitel tekst gebruiken.

-helpbestand filet
Deze optie wordt momenteel genegeerd.

Wanneer geïmplementeerd, zal het het XHTML-fragment gebruiken in filet voor de inhoud van de helppagina
in plaats van de standaard helptekst.

Controlling de Output.

-d directory
Plaats alle uitvoerbestanden in directory (en submappen). directory zal gemaakt worden
als het niet bestaat, inclusief alle niet-bestaande bovenliggende mappen en alle vereiste
submappen.

Als dit niet is opgegeven, wordt de uitvoer in de huidige map geplaatst.

-plaats naam
Gebruik taal naam in plaats van de standaardlandinstelling voor alle doeleinden.

naam moet een landinstelling zijn in de vorm ll_CC[_VAR] WAAR ll is een kleine twee-
letter ISO-639 taalcode, CC is een optioneel tweeletterig ISO-3166-land in hoofdletters
code, en VAR is een optionele variantcode. Bijvoorbeeld, en specificeert Engels, nl_NL
specificeert Amerikaans Engels, en nl_US_WIN specificeert een afwijkende variant van het Amerikaans Engels
Local.

Merk op dat de semantiek van deze optie exact overeenkomt met die van de constructors
van klasse java.util.Locale.

Deze optie bepaalt momenteel alleen welke Collator wordt gebruikt voor het sorteren van uitvoer
elementen. Dit betekent dat de landinstelling alleen effect heeft als u niet-
ASCII-tekens in id's.

-tekenset karakterset
Verouderd. Overschrijf de gespecificeerde codering in XHTML-uitvoerbestanden met de gegeven
by karakterset.

Als deze optie niet wordt gegeven, wordt de coderingsspecificatie in uitvoer XHTML gekozen om:
overeenkomen met de codering die is gebruikt bij het schrijven van het bestand (de codering gegeven met -docencodering,
of de standaardcodering van uw platform).

De semantiek voor karakterset worden hier gespecificeerd:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncNaam>. Voor alle praktische doeleinden,
ze zijn identiek aan die van de andere opties die charset-parameters accepteren.

Deze optie is hier voor compatibiliteit met: javadoc en moet worden vermeden.

-docencodering karakterset
Gebruik de gegeven charset-codering bij het schrijven van uitvoerbestanden in plaats van die van uw platform
standaard codering.

Voorbeelden voor karakterset zijn US-ASCII, ISO-8859-1 or UTF-8.

De semantiek van deze optie komt exact overeen met die van de constructors van class
java.util.Locale.

-geldigehtml
Forceer het genereren van geldige XHTML-code. Dit breekt de compatibiliteit met de traditionele
Javadoc-tool tot op zekere hoogte.

Als deze optie is opgegeven, worden ankernamen vervormd zodat ze geldig zijn
volgens de XHTML 1.1-specificatie. Echter, een documentatieset gegenereerd met
deze optie kan niet worden gekoppeld aan het correct gebruiken van de traditionele Javadoc-tool. Het kan
worden gekoppeld aan prima met behulp van Gjdoc, dat wel.

Zonder deze optie gebruiken ankernamen voor uitvoerbare klasleden de traditionele
formaat, bijvoorbeeld: "foo(String,int[])". Dit is compatibel met de traditionele
Javadoc-tool, maar volgens zowel de HTML 4.0- als XHTML 1.0- en 1.1-specificaties,
dit formaat bevat illegale tekens. Haakjes, vierkante haken en de komma
zijn niet toegestaan ​​in ankernamen.

-basisurl url
Maak een pagina-URL vast ten opzichte van url in elke gegenereerde pagina.

Als u documentatie aan het genereren bent die exclusief beschikbaar zal zijn op een bepaald
URL, moet u deze optie gebruiken om deze URL op te geven.

Dit kan helpen om bepaalde door spammers gebruikte omleidingsaanvallen te voorkomen, en het kan nuttig zijn
voor bepaalde webclients.

Breedsprakigheid Opties

-rustig
Onderdruk alle uitvoer behalve waarschuwingen en foutmeldingen.

-uitgebreid
Wees zeer uitgebreid over wat gjdoc doet.

Deze optie wordt momenteel genegeerd.

Virtueel Machine Opties

Zon javadoc tool lijkt te zijn gebaseerd op Javac en als zodanig lijkt het te werken op de VM
niveau. gjdoc, daarentegen, is een pure Java-toepassing.

daarom gjdoc kan alleen de volgende opties op VM-niveau vervalsen of simuleren.

-klassenpad padlijst
Stel de virtuele machine in klassenpad naar padlijst.

In de meeste gevallen moet u gebruik maken van -docletpad or -tagletpad in plaats van deze optie.

padlijst moet een of meer paden zijn naar een map of jar-bestand, gescheiden door uw
padscheidingsteken van het platform (meestal : or ;).

Als deze optie niet wordt onderschept op wrapper-niveau, gjdoc vervalst het momenteel door
bellen System.setProperty("java.class.path", padlijst); en geeft een waarschuwing af.

-bootklassepad padlijst
Stel de virtuele machine in bootklassepad naar padlijst.

Als deze optie niet wordt onderschept op wrapper-niveau, gjdoc geeft een waarschuwing af.

-Jvmopt
Geef een willekeurige parameter door aan de virtuele machine gjdoc draait op.

Als deze optie niet wordt onderschept op wrapper-niveau, gjdoc probeert de na te bootsen
optie en geeft een waarschuwing weer.

Momenteel alleen de VM-optie -D voor het instellen van systeemeigenschappen wordt geëmuleerd.

Gebruik gjdoc-4.8 online met onworks.net-services