gjdoc-4.8 - Online nel cloud

PROGRAMMA:

NOME

cp-tools - Guida agli strumenti di GNU Classpath

SINOSSI

gjdoc [-percorso sorgente lista dei percorsi]
[-tutti] [-sottopacchetti pacco: pacco:...] [-escludere lista dei pacchetti]
[-codifica set di caratteri] [-locale Nome] [-fonte rilasciare]
[-pubblico] [-protetto] [-pacchetto] [-privato]
[-doctitolo testo] [-intestazione testo] [-piè di pagina testo] [-parte inferiore testo]
[-LINK URL] [-linkoffline URL sentiero] [-nessun qualificatore pacco: pacco:...]
[-tagletpath lista dei percorsi] [-tagliatelle nome della classe] [-etichetta tagpec]
[-uso] [-linksource] [-splitindex] [-noindice] [-nessun albero]
[-versione] [-autore] [-noce] [-aggiungi foglio di stile filetto]
[-d dir.destinazione]
[Packages...] [file sorgenti...] [@cmdfile]

gjdoc [-percorso sorgente lista dei percorsi]
[-tutti] [-sottopacchetti pacco: pacco:...] [-escludere lista dei pacchetti]
[-codifica set di caratteri] [-locale Nome] [-fonte rilasciare]
[-pubblico] [-protetto] [-pacchetto] [-privato]
[-docletpath lista dei percorsi] [-doclet nome della classe]
[Packages...] [file sorgenti...] [@cmdfile]
[opzioni doclet]

gjdoc --Aiuto

gjdoc --versione

Qui sono elencate solo le opzioni più utili; vedi sotto per il resto.

DESCRIZIONE

Gjdoc può essere utilizzato in due modi: come strumento di documentazione autonomo o come driver per a
Doclet specificato dall'utente.

Nella modalità predefinita, Gjdoc utilizzerà lo Standard Doclet HtmlDoclet per generare un insieme di
Pagine HTML. L'uso canonico è:

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

Qui, origine/java/ è la radice della gerarchia delle classi del codice sorgente, -tutti significa che tutto valido
I file Java trovati in questa directory principale dovrebbero essere elaborati e API-documenti/ Europe è
directory in cui deve essere collocata la documentazione generata.

Per ulteriori informazioni sull'esecuzione di Doclet diversi dal Doclet standard, fare riferimento al manuale.

VERSIONI

Opzione Sommario by Tipologia

Ecco un riepilogo di tutte le opzioni di Gjdoc e Standard Doclet, raggruppate per
genere. Le spiegazioni sono nelle sezioni seguenti.

Fonte Impostato Opzioni
-percorso sorgente lista dei percorsi -sottopacchetti lista dei pacchetti -escludere lista dei pacchetti

Fonte Formato Opzioni
-fonte rilasciare -codifica codifica -breakiteratore

Interconnessione Opzioni
-LINK URL -linkoffline URL filetto -nessun qualificatore pacco: pacco:...

Generazione Opzioni
-autore -licenzatesto -uso -versione -splitindex -noindice
-nodeprecato -lista dei nodi -nessun aiuto -non barra di navigazione
-noce -nessun albero -pubblico -protetto -pacchetto -privato
-sottodir dei file doc -excludesottodirfiledoc cognome
-linksource

Uscita Opzioni
-d -locale Nome -set di caratteri set di caratteri -docencodifica set di caratteri
-validhtml -baseurl URL

Decorazione Opzioni
-titolo della finestra testo -doctitolo testo -titolo testo
-intestazione testo -piè di pagina testo -parte inferiore testo
-file di aiuto filetto -file del foglio di stile filetto -aggiungi foglio di stile filetto
-gruppo intestazione di gruppo pkgmodello:pkgmodello:...

Tagletto Opzioni
-tagletpath -tagliatelle nomeclasse -etichetta tagpec

Doclet Opzioni
-docletpath -doclet nomeclasse

Verbosità Opzioni
-silenzioso -verboso

virtuale Confezionatrici Verticali VFFS Opzioni
-percorso di classe -bootclasspath -J vmopt

Selezione quale Fonte File a Processo

-s lista dei percorsi
-percorso sorgente lista dei percorsi
Cerca i file di origine nella directory o nelle directory specificate.

lista dei percorsi dovrebbe essere uno o più percorsi di directory separati dal percorso della tua piattaforma
separatore (di solito : or ;).

Se questa opzione non è data, gjdoc cercherà i file sorgente nell'attuale
directory.

Le directory specificate dovrebbero essere directory radice in termini di pacchetto Java
sistema. Ad esempio, se vuoi generare la documentazione per le classi nel pacchetto
pippo.bar, è necessario specificare la directory contenente il livello superiore foo sottocartella,
non la directory pipì/bar/ in cui risiedono i file di origine Java.

L'alias abbreviato -s è specifico per gjdoc e non compatibile con Sun javadoc.

-tutti
[SPERIMENTALE] Elabora tutti i file sorgente Java validi trovati nelle directory elencate in
il percorso di origine e le relative sottodirectory.

Questa è un'opzione specifica per gjdoc e non compatibile con Sun javadoc.

-sottopacchetti pacco: pacco:...
Elabora le classi nei pacchetti Java indicati e in tutti i sottopacchetti, in modo ricorsivo.
Nota che più nomi di pacchetti devono essere separati da due punti invece che da spazi.

-escludere pacco: pacco:...
Non elaborare le classi nei pacchetti Java forniti e in tutti i sottopacchetti, in modo ricorsivo.
Questa opzione può essere utilizzata insieme a -tutti or -sottopacchetti per escludere
singoli pacchetti o sottoalberi di pacchetti dall'output.

Packages...
Elabora tutte le classi nei pacchetti Java indicati.

file sorgenti...
Elabora le classi nei file sorgente Java indicati.

specificando , il Formato of Ingresso File

-fonte rilasciare
Si supponga che i file di origine siano destinati alla data versione della piattaforma Java.

rilasciare dovrebbe essere il numero di versione di una versione della piattaforma Java nel formato
MAGGIORE.MINORE, per esempio 1.4.

Questa opzioneèattualmente ignorata eccetto che viene generato un errore se un numero di release
diverso 1.2, 1.3 or 1.4 è specificato.

-codifica set di caratteri
Supponiamo che i file sorgente siano codificati usando set di caratteri.

Esempi per set di caratteri sono US-ASCII, ISO-8859-1 or UTF-8.

La semantica di set di caratteri sono identici a quelli di
java.nio.charset.Charset.forName(Stringa).

-breakiteratore
Usa java.text.BreakIterator della locale invece della prima frase interna
rivelatore.

Per impostazione predefinita, gjdoc utilizza un algoritmo interno per determinare dove finisce una frase. quando
questa opzione è data, utilizzerà invece il java.text.BreakIterator esempio per il
locale dato con -locale (o l'impostazione internazionale predefinita).

Questa opzione dovrebbe essere specificata al momento dell'applicazione gjdoc al codice sorgente commentato in modo non
lingua latina per la quale il rilevatore della prima frase predefinito non funziona. Per tutti
in altri casi, l'impostazione predefinita (non utilizzare BreakIterator) produce risultati migliori al momento del
tempo di questo scritto.

Interconnessione con Altro Documentazione Set

-LINK URL
Crea collegamenti ipertestuali a un altro set di documentazione.

Per impostazione predefinita, gjdoc creerà solo collegamenti ipertestuali alle classi nel set di origine. Usa questo
opzione per creare ulteriori collegamenti ipertestuali alle classi coperte da quanto specificato
insieme di documentazione.

URL dovrebbe essere l'URL radice dell'altro set di documentazione. Ad esempio, per aggiungere
collegamenti ipertestuali a GNU Classpath, specificare quanto segue:

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

I -LINK l'opzione può essere specificata più volte.

Si noti che specificando il -LINK l'opzione causerà un accesso HTTP ogni volta che gjdoc è
invocato. Puoi usare -linkoffline invece di evitare questo accesso.

-linkoffline URL filetto
Crea collegamenti ipertestuali a un altro set di documentazione che è presente anche nel file locale
.

Questa opzione funziona esattamente come -LINK, tranne che accede al file system locale
invece della rete per determinare quali classi sono coperte dal collegato
insieme di documentazione.

Quando si usa -linkoffline non si accede affatto al set di documentazione remota, il che può
accelerare significativamente il tempo di generazione a seconda della connessione di rete. Il
i collegamenti ipertestuali generati al set di documentazione si riferiscono tuttavia al set remoto, non a
quello locale, in modo da poter distribuire la documentazione senza ulteriori operazioni
dipendenze.

I -linkoffline l'opzione può essere specificata più volte.

-nessun qualificatore pacco: pacco:...
Non qualificare i nomi delle classi nei pacchetti forniti con il nome del pacchetto.

Per impostazione predefinita, il nome di una classe viene visualizzato non qualificato solo se la classe fa parte del
insieme sorgente o un insieme di documentazione collegato e qualificato con il nome del suo
pacchetto contenente se non lo è. Puoi usare questa opzione per forzare i nomi non qualificati
per le classi anche se non fanno parte della documentazione.

Ad esempio, di solito un riferimento alla classe String è rappresentato pienamente qualificato come
java.lang.String (a meno che non ti colleghi al set di documentazione appropriato usando -LINK)
perché non fa parte del set di documentazione. Puoi specificare -nessun qualificatore
java.lang per rendere gli stessi riferimenti proprio come Corda.

Nota che per tutti i nomi di classe non qualificati, viene fornito un tooltip quando inserisci il tuo
puntatore del mouse su di esso nella documentazione HTML.

-nessun qualificatore contro tutti i
Ometti il ​​qualificatore del nome del pacchetto da tutti i nomi delle classi.

Specificare questa opzione per omettere del tutto i qualificatori del nome del pacchetto,

Selezione quale Informazioni a Generare

-pubblico
Includere nell'output solo i membri pubblici delle classi pubbliche. Per impostazione predefinita, protetto
sono inclusi anche i membri della classe.

-protetto
Includere nell'output i membri pubblici o protetti delle classi pubbliche. Questo è il
predefinito.

-pacchetto
Includere membri pubblici, protetti e privati ​​del pacchetto di membri pubblici e privati ​​del pacchetto
classi.

-privato
Includere tutte le classi e i membri della classe indipendentemente dal loro livello di accesso.

-splitindex
Genera una pagina indice per lettera invece di una singola pagina indice monolitica.

Per impostazione predefinita, l'indice creato dal Doclet standard contiene tutte le voci su un singolo
pagina. Questo va bene per piccoli set di documentazione, ma per grandi set dovresti
specificare questa opzione.

-noce
ignorare @da tag nei commenti javadoc.

Per impostazione predefinita, l'output generato contiene sezioni che elencano la versione della tua API
da cui esiste il pacchetto, la classe o il membro della classe in questione quando questo tag è
incontrato. Specificare questa opzione per omettere queste informazioni.

-nessun albero
Non generare pagine ad albero.

Per impostazione predefinita, l'output generato include un albero di ereditarietà per pacchetto e - se
il set di documentazione è costituito da più pacchetti: una pagina con l'ereditarietà completa
albero. Specificare questa opzione per omettere la generazione di queste pagine.

-noindice
Non emettere l'indice alfabetico.

Per impostazione predefinita, gjdoc genera un indice alfabetico di tutti gli elementi del programma nel
set di documentazione (pacchetti, classi, classi interne, costruttori, metodi e
campi). Specificare questa opzione per omettere queste informazioni.

-nessun aiuto
Non generare la pagina di aiuto.

Questa opzione è attualmente ignorata poiché il Doclet standard non fornisce una pagina di aiuto.

-nodeprecato
Non emettere informazioni in linea su pacchetti, classi o membri di classi deprecati.

Per impostazione predefinita, il Doclet standard aggiunge un paragrafo evidenziato con deprecazione
informazioni alla descrizione di ogni elemento del programma deprecato. Specifica questo
possibilità di omettere queste informazioni.

-lista dei nodi
Non emettere la pagina di riepilogo per gli elementi API deprecati.

Per impostazione predefinita, il Doclet standard genera una pagina che elenca tutti gli elementi API deprecati
insieme a una descrizione della deprecazione che di solito include il motivo della deprecazione
e possibili alternative. Specificare questa opzione per omettere queste informazioni.

-non barra di navigazione
Non restituire la barra di navigazione, l'intestazione e il piè di pagina.

Per impostazione predefinita, ogni pagina di output è dotata di una barra di navigazione superiore (che può includere
un'intestazione specificata dall'utente) e una barra di navigazione inferiore (che può includere un'intestazione
piè di pagina specificato). Specificare questa opzione per omettere questa decorazione.

-nessun commento
Ometti tutto il testo della documentazione dai file generati e genera solo dichiarazioni e
relazioni tra gli elementi del programma.

Questa opzione è qui per compatibilità con javadoc. Se hai intenzione di estrarre
informazioni sul tuo progetto tramite gjdoc, dovresti considerare l'utilizzo di un Doclet diverso
per i tuoi scopi invece, ad esempio XmlDoclet. Puoi anche usare l'API Doclet
direttamente implementando un nuovo Doclet.

-linksource
Genera una pagina con il codice sorgente evidenziato dalla sintassi per ogni classe. Per impostazione predefinita, questo
la pagina non viene generata.

È possibile accedere al codice sorgente facendo clic sul pulsante denominato "Sorgente" nel
barra di navigazione, o facendo clic sul nome di un costruttore, campo, metodo o interno
class nella sezione dei dettagli di una pagina di documentazione della classe.

-uso
Genera una pagina con informazioni di riferimento incrociato. Per impostazione predefinita, questa pagina non lo è
generato.

È possibile accedere alle informazioni di riferimento incrociato facendo clic sul pulsante etichettato
"Utilizza" nella barra di navigazione.

La pagina "Usa" elenca tutte le classi/interfacce nel set di documentazione che
estendere/implementare la classe (tipo) in questione; campi del tipo; metodi o
costruttori che accettano un parametro del tipo; metodi che restituiscono il tipo; e
metodi o costruttori che lanciano il tipo.

-autore
Includere le informazioni sull'autore nell'output.

Quando specificato, le informazioni sull'autore come specificato utilizzando il @autore etichetta in javadoc
i commenti sono incorporati nell'output. Per impostazione predefinita, @autore i tag vengono ignorati.

-versione
Includere le informazioni sulla versione nell'output.

Quando specificato, le informazioni sulla versione come specificato utilizzando il @versione etichetta in javadoc
i commenti sono incorporati nell'output. Per impostazione predefinita, @versione i tag vengono ignorati.

-licenzatesto
Supponiamo che il primo commento in ogni file sorgente contenga il testo della licenza e aggiungi
informazioni sulla licenza al piè di pagina di ogni pagina di classe generata.

Questa è un'opzione specifica per gjdoc e non compatibile con Sun javadoc.

Questa opzione è destinata all'uso con progetti gratuiti e open source in cui il codice sorgente
è in genere preceduto da un commento sulla licenza standard, quando sussistono motivi legali
per aver incluso la licenza nella documentazione.

-sottodir dei file doc
Copia ricorsivamente tutti i file nel file-doc sottodirectory di ogni directory del pacchetto.

Di solito, solo i file nel file-doc le sottodirectory vengono copiate senza scendere
ricorsivamente.

-excludesottodirfiledoc Nome:Nome: ...
Non copiare alcune directory direttamente sotto il file-doc sottodirectory quando
discendente ricorsivamente.

L'argomento di questa opzione dovrebbe essere un elenco di nomi di directory separati da due punti.

Questa opzione ha senso solo se -sottodir dei file doc è anche specificato. In questo caso, qualsiasi
sottodirectory situata direttamente sotto a file-doc directory viene omessa se elencata.

Custom Documentazione tag

-tagletpath lista dei percorsi
Cerca lista dei percorsi quando si caricano le classi Taglet successive specificate usando -tagliatelle.

lista dei percorsi dovrebbe essere uno o più percorsi verso una directory o un file jar, separati dal tuo
separatore di percorso della piattaforma (di solito : or ;).

-tagliatelle nomeclasse
Registra un Taglet.

nomeclasse dovrebbe essere il nome completo di una classe Java che implementa
com.sun.tools.doclets.Taglet.

Le classi Taglet verranno caricate dal classpath specificato usando -tagletpath,da
il classpath specificato usando -percorso di classe e dal classpath predefinito.

Consulta la documentazione di com.sun.tools.doclets.Taglet per maggiori informazioni.

Nota che per i tag semplici, c'è anche -etichetta.

-etichetta tagpec
Registra un Taglet generico.

Il formato di tagpec deve essere : :" ".

nome tag è il nome del tag da abbinare, senza il segno @ iniziale.

bandiere è uno o più dei seguenti caratteri, dove ogni carattere specifica a
contesto del codice sorgente in cui il tag deve essere riconosciuto.

a tutti i contesti

c costruttori

f campi

m metodi

o panoramica

p Packages

t tipi (classi, interfacce, eccezioni, errori)

X carattere speciale che disabilita temporaneamente del tutto il Taglet.

testa di tag è la stringa da visualizzare nell'intestazione della sezione dedicata al tag in
domanda.

Ad esempio, per definire una corrispondenza di tag @cvsid che deve essere accettato in una panoramica,
pacchetto e digitare le pagine e che è etichettato con l'intestazione CVS ID, tu vorresti
specificare:

-tag cvsid:tpo:"ID CVS"

Diciamo che un commento javadoc di classe contiene

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

Quindi l'output HTML conterrà qualcosa del tipo

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

corsa Altro Doclet

-docletpath lista dei percorsi
Cerca lista dei percorsi quando si caricano le classi per il Doclet specificato usando -doclet.

lista dei percorsi dovrebbe essere uno o più percorsi verso una directory o un file jar, separati dal tuo
separatore di percorso della piattaforma (di solito : or ;).

-doclet nome della classe
Eseguire il doclet specificato invece dell'HtmlDoclet standard.

nome della classe dovrebbe essere il nome completo di una classe che ha un valore predefinito pubblico
costruttore e contengono un metodo con la seguente firma:

importare com.sun.javadoc.RootDoc;
inizio booleano statico pubblico (RootDoc ​​rootDoc)

Le classi Doclet verranno caricate dal classpath specificato usando -docletpath,da
il classpath specificato usando -percorso di classe e dal classpath predefinito.

I inizia a dovrebbe elaborare le informazioni esposte dall'API Doclet tramite rootDoc
e ritorno vero sul successo, falso in caso di fallimento.

Se si utilizza un doclet di terze parti, fare riferimento alla relativa documentazione per ulteriori informazioni
Istruzioni. Tieni presente che il supporto per i doclet di terze parti è sperimentale. Per favore
segnalare eventuali problemi riscontrati o fornire feedback durante l'esecuzione con successo
applet di terze parti.

Questa opzione può essere specificata più volte, nel qual caso vengono eseguiti tutti i doclet
con lo stesso albero delle informazioni esposto tramite l'API Doclet per ogni esecuzione di Doclet.

Aggiunta Informazioni a , il Uscita

-titolo della finestra testo
Usa il testo come prefisso del titolo della finestra del browser.

Quando specificato, il titolo della finestra del browser per ogni pagina sarà preceduto da testo
invece della stringa predefinita generated API Documentazione.

testo dovrebbe essere testo normale (non dovrebbe contenere tag HTML).

-doctitolo testo
Imposta il testo dell'intestazione della pagina panoramica su testo.

testo dovrebbe essere una breve stringa di testo normale.

Quando si genera la documentazione per un singolo pacchetto, specificando questa opzione si forza
generazione della pagina panoramica.

-intestazione testo html
Aggiungi testo html nell'angolo superiore destro di ogni pagina generata. testo html è generalmente
impostato sul nome del progetto da documentare.

-piè di pagina testo html
Aggiungi testo html nell'angolo inferiore destro di ogni pagina generata. testo html è spesso
impostato sullo stesso valore di per -intestazione.

-parte inferiore testo html
Aggiungi testo html fino alla fine di ogni pagina generata, coprendo l'intera larghezza di
la pagina. Quando specificato, testo html di solito consiste in un avviso di copyright e/o
collegamenti ad altre pagine del progetto.

-aggiungi foglio di stile filetto
Aumenta i fogli di stile CSS predefiniti con il foglio di stile specificato dall'utente filetto.

Il foglio di stile dato viene semplicemente caricato da ogni pagina HTML oltre a quella predefinita
quelli, come l'ultimo foglio di stile.

Si noti che si applicano le regole CSS a cascata. Cioè, le tue proprietà di stile saranno solo
assegnati se hanno un ordine a cascata superiore a gjdoclo stile predefinito. uno semplice
il modo per assicurarti che questo sia il caso è dichiarare le tue sostituzioni ! important.

Vederehttp://www.w3.org/TR/REC-CSS2/cascade.html#ordine-a-cascata>.

-gruppo intestazione pkgjolly:pkgjolly: ...
Disporre i pacchetti dati in un gruppo separato nella pagina della panoramica.

Il primo argomento dovrebbe essere un breve testo semplice che viene utilizzato come titolo del
gruppo pacchetto. Il secondo argomento dovrebbe essere un elenco di pacchetti separato da due punti
caratteri jolly. Il gruppo sarà composto da tutti i pacchetti nel set di documentazione il cui nome
corrisponde a uno dei caratteri jolly forniti.

C'è solo un carattere jolly, *, che corrisponde a entrambe le lettere nel nome del pacchetto
componenti e il . separare i componenti del nome del pacchetto. Per esempio, j*espressione regolare sarebbe
pacchetto di corrispondenza java.util.regex. Un esempio più utile sarebbe javax.swing* in modo che corrisponda
javax.swing e tutti i suoi sotto-pacchetti.

Questa opzione può essere data più volte.

FIXME: Informazioni sull'annidamento dei gruppi qui.

gjdoc -group "Core Classi" 'java*' \
-group "Swing" 'javax.swing*' \
-group "API XML" 'javax.xml*' \
-group "Altre estensioni" javax* \
...

-panoramica filetto
Aggiungi il frammento del corpo XHTML da filetto alla pagina della panoramica.

filetto dovrebbe contenere un frammento XHTML con l'HTML stile di vita tag come nodo radice.

Questa opzione può essere utilizzata per fornire una descrizione del set di documentazione nel suo insieme.

Quando specificato, la prima frase del frammento verrà messa sopra le tabelle
elencando i pacchetti documentati, insieme a un collegamento alla copia completa del frammento
che è posto sotto le tabelle.

Quando si genera la documentazione per un singolo pacchetto, specificando questa opzione si forza
generazione della pagina panoramica.

-file del foglio di stile filetto
Usa il foglio di stile CSS in filetto invece dei fogli di stile CSS predefiniti.

Se vuoi sovrascrivere solo parti dei fogli di stile predefiniti, usa -aggiungi foglio di stile
anziché.

-titolo testo
Deprecato. Usa il -doctitolo testo anziché.

-file di aiuto filetto
Questa opzione è attualmente ignorata.

Quando implementato, utilizzerà il frammento XHTML in filetto per i contenuti della pagina di aiuto
invece del testo della guida predefinito.

Controllo , il Produzione.

-d elenco
Inserisci tutti i file di output in elenco (e sottodirectory). elenco sarà creato
se non esiste, incluse tutte le directory padre non esistenti e tutte le necessarie
sottodirectory.

Se non specificato, l'output verrà inserito nella directory corrente.

-locale Nome
Usa locale Nome invece della locale predefinita per tutti gli scopi.

Nome dovrebbe essere un identificatore locale nella forma ll_CC[_VAR] where ll è un due minuscolo-
lettera codice lingua ISO-639, CC è un paese ISO-3166 di due lettere maiuscole opzionale
codice, e VAR è un codice variante opzionale. Per esempio, en specifica l'inglese, it_IT
specifica l'inglese americano e it_US_WIN specifica una variante deviante dell'inglese americano
Locale.

Nota che la semantica di questa opzione corrisponde esattamente a quella dei costruttori
di classe java.util.Locale.

Questa opzione attualmente determina solo quale Collator viene utilizzato per ordinare l'output
elementi. Ciò significa che la localizzazione avrà effetto solo quando si utilizzano non
Caratteri ASCII negli identificatori.

-set di caratteri set di caratteri
Deprecato. Sostituisci la codifica specificata nei file XHTML di output con quella data
by set di caratteri.

Se questa opzione non viene fornita, la specifica di codifica nell'output XHTML viene scelta per
corrisponde alla codifica utilizzata durante la scrittura del file (la codifica fornita con -docencodifica,
o la codifica predefinita della tua piattaforma).

La semantica per set di caratteri sono qui specificati:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-Nome Enc>. A tutti gli effetti pratici,
sono identici a quelli delle altre opzioni che accettano parametri di set di caratteri.

Questa opzione è qui per compatibilità con javadoc e dovrebbe essere evitato.

-docencodifica set di caratteri
Usa la codifica del set di caratteri specificata quando scrivi i file di output invece di quelli della tua piattaforma
codifica predefinita.

Esempi per set di caratteri sono US-ASCII, ISO-8859-1 or UTF-8.

La semantica di questa opzione corrisponde esattamente a quella dei costruttori di class
java.util.Locale.

-validhtml
Forza la generazione di codice XHTML valido. Questo rompe la compatibilità con il tradizionale
Strumento Javadoc in una certa misura.

Se questa opzione è specificata, i nomi delle ancore verranno alterati in modo che siano validi
secondo la specifica XHTML 1.1. Tuttavia, un set di documentazione generato con
questa opzione non può essere collegata correttamente utilizzando lo strumento Javadoc tradizionale. Può
essere collegato bene usando Gjdoc, però.

Senza questa opzione, i nomi di ancoraggio per i membri della classe eseguibile utilizzano il tradizionale
formato, ad esempio: "foo(String,int[])". Questo è compatibile con il tradizionale
strumento Javadoc, ma secondo le specifiche HTML 4.0 e XHTML 1.0 e 1.1,
questo formato include caratteri non validi. Parentesi, parentesi quadre e virgola
non sono consentiti nei nomi di ancoraggio.

-baseurl URL
Collega l'URL di una pagina relativo a URL in ogni pagina generata.

Se stai generando documentazione che sarà disponibile esclusivamente ad un certo
URL, dovresti usare questa opzione per specificare questo URL.

Questo può aiutare a evitare alcuni attacchi di reindirizzamento utilizzati dagli spammer e può essere utile
per determinati client Web.

Verbosità Opzioni

-silenzioso
Sopprime tutto l'output ad eccezione di avvisi e messaggi di errore.

-verboso
Sii molto prolisso su cosa gjdoc sta facendo.

Questa opzione è attualmente ignorata.

virtuale Confezionatrici Verticali VFFS Opzioni

Sun javadoc lo strumento sembra essere basato su javac e come tale sembra operare sulla VM
livello. gjdoc, al contrario, è una pura applicazione Java.

Perciò, gjdoc può solo falsificare o simulare le seguenti opzioni a livello di macchina virtuale.

-percorso di classe lista dei percorsi
Imposta la macchina virtuale percorso di classe a lista dei percorsi.

Nella maggior parte dei casi dovresti usare -docletpath or -tagletpath invece di questa opzione.

lista dei percorsi dovrebbe essere uno o più percorsi verso una directory o un file jar, separati dal tuo
separatore di percorso della piattaforma (di solito : or ;).

Se questa opzione non viene intercettata a livello di wrapper, gjdoc attualmente lo finge da
chiamata System.setProperty("java.class.path", lista dei percorsi); ed emette un avviso.

-bootclasspath lista dei percorsi
Imposta la macchina virtuale bootclasspath a lista dei percorsi.

Se questa opzione non viene intercettata a livello di wrapper, gjdoc emette un avviso.

-Jvmopt
Passa un parametro arbitrario alla macchina virtuale gjdoc gira su.

Se questa opzione non viene intercettata a livello di wrapper, gjdoc cerca di emulare il
opzione ed emette un avviso.

Attualmente, solo l'opzione VM -D per l'impostazione delle proprietà del sistema viene emulato.

Usa gjdoc-4.8 online utilizzando i servizi onworks.net