gjdoc-4.8 - En ligne dans le Cloud

PROGRAMME:

Nom

cp-tools - Guide des outils de chemin de classe GNU

SYNOPSIS

gjdoc[-cheminsource liste de chemins]
[-tout] [-sous-paquets paquet:paquet:...] [-exclure liste de paquets]
[-codage jeu de caractères] [-lieu prénom] [-source libérer]
[-Publique] [-protégé] [-paquet] [-privé]
[-titredoc texte] [-entête texte] [-bas de page texte] [-bas texte]
[-lien url] [-lienhors ligne url chemin] [-pas de qualificatif paquet:paquet:...]
[-chemintaglet liste de chemins] [-étiquette nom du cours] [-marque spécif de balise]
[-utiliser] [-liensource] [-index divisé] [-noindex] [-notrearbre]
[-version] [-auteur] [-nos depuis] [-ajouter une feuille de style filet]
[-d rép_cible]
[Forfaits...] [fichiers source...] [@fichier cmd]

gjdoc[-cheminsource liste de chemins]
[-tout] [-sous-paquets paquet:paquet:...] [-exclure liste de paquets]
[-codage jeu de caractères] [-lieu prénom] [-source libérer]
[-Publique] [-protégé] [-paquet] [-privé]
[-chemindoclet liste de chemins] [-doclet nom du cours]
[Forfaits...] [fichiers source...] [@fichier cmd]
[options de doclet]

gjdoc --Aidez-moi

gjdoc --version

Seules les options les plus utiles sont répertoriées ici ; voir ci-dessous pour le reste.

DESCRIPTION

Gjdoc peut être utilisé de deux manières : en tant qu'outil de documentation autonome ou en tant que pilote pour un
Doclet spécifié par l'utilisateur.

Dans le mode par défaut, Gjdoc utilisera le Doclet Standard DocletHtml générer un ensemble de
pages HTML. L'usage canonique est :

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

Ici, src/java/ est la racine de votre hiérarchie de classes de code source, -tout signifie que tout valide
Les fichiers Java trouvés dans ce répertoire racine doivent être traités et api-docs/ est
répertoire où la documentation générée doit être placée.

Pour en savoir plus sur l'exécution de doclets autres que le doclet standard, reportez-vous au manuel.

OPTIONS

Option Résumé by Type

Voici un résumé de toutes les options de Gjdoc et du Doclet Standard, regroupées par
taper. Les explications se trouvent dans les sections suivantes.

Identifier Ensemble Options
-cheminsource liste de chemins -sous-paquets liste de paquets -exclure liste de paquets

Identifier Format Options
-source libérer -codage codage -breakitérateur

Interconnexion Options
-lien url -lienhors ligne url filet -pas de qualificatif paquet:paquet:...

Génération Options
-auteur -texte de la licence -utiliser -version -index divisé -noindex
-nodedéprécié -nodeprecatedlist -pas d'aide -nonavbar
-nos depuis -notrearbre -Publique -protégé -paquet -privé
-docfilessous-répertoires -sous-répertoire de fichiers occlus dis-moi
-liensource

Sortie Options
-d -lieu prénom -jeu de caractères jeu de caractères -docencodage jeu de caractères
-validhtml -baseurl url

Décoration Options
-titre de la fenêtre texte -titredoc texte -Titre texte
-entête texte -bas de page texte -bas texte
-fichier d'aide filet -fichier de feuille de style filet -ajouter une feuille de style filet
-groupe tête de groupe modèle de paquet : modèle de paquet :...

Taglet Options
-chemintaglet -étiquette nom du cours -marque spécif de balise

Doclet Options
-chemindoclet -doclet nom du cours

Verbosité Options
-silencieux -verbeux

Salle de conférence virtuelle Machine Options
-chemin de classe -chemin de classe de démarrage -J vmopt

Sélection qui Identifier Fichiers à Processus

-s liste de chemins
-cheminsource liste de chemins
Recherchez les fichiers source dans le ou les répertoires spécifiés.

liste de chemins devrait être un ou plusieurs chemins de répertoire séparés par le chemin de votre plate-forme
séparateur (généralement : or ;).

Si cette option n'est pas donnée, gjdoc recherchera les fichiers sources dans le
répertoire.

Les répertoires spécifiés doivent être des répertoires racine en termes de package Java
système. Par exemple, si vous souhaitez générer de la documentation pour les classes dans package
foo.bar, vous devez spécifier le répertoire contenant le niveau supérieur foo sous-répertoire,
pas le répertoire bouffe/bar/ dans lequel résident les fichiers source Java.

L'alias abrégé -s est spécifique à gjdoc et non compatible avec Sun Javadoc.

-tout
[EXPÉRIMENTAL] Traiter tous les fichiers source Java valides trouvés dans les répertoires répertoriés dans
le chemin source et leurs sous-répertoires.

Il s'agit d'une option spécifique à gjdoc et non compatible avec Sun Javadoc.

-sous-paquets paquet:paquet:...
Traitez les classes dans les packages Java donnés et tous les sous-packages, de manière récursive.
Notez que plusieurs noms de packages doivent être séparés par des deux-points au lieu d'espaces.

-exclure paquet:paquet:...
Ne traitez pas les classes dans les packages Java donnés et tous les sous-packages, de manière récursive.
Cette option peut être utilisée avec -tout or -sous-paquets afin d'exclure
packages individuels ou sous-arborescences de packages à partir de la sortie.

Forfaits
Traitez toutes les classes dans les packages Java donnés.

fichiers source
Traitez les classes dans les fichiers source Java donnés.

Spécification le Format of Entrée Fichiers

-source libérer
Supposons que les fichiers source ciblent la version donnée de la plate-forme Java.

libérer doit être le numéro de version d'une version de la plate-forme Java au format
MAJEUR.MINEUR, par exemple 1.4.

Cette option est actuellement ignorée sauf qu'une erreur est générée si un numéro de version
autre que 1.2, 1.3 or 1.4 est spécifié.

-codage jeu de caractères
Supposons que les fichiers sources sont encodés à l'aide jeu de caractères.

Exemples pour jeu de caractères US-ASCII, ISO-8859-1 or UTF-8.

La sémantique de jeu de caractères sont identiques à ceux de
java.nio.charset.Charset.forName(String).

-breakitérateur
Utilisez le java.text.BreakIterator de la locale au lieu de la première phrase interne
détecteur.

Par défaut, gjdoc utilise un algorithme interne pour déterminer où se termine une phrase. Lorsque
cette option est donnée, il utilisera à la place le java.text.BreakIterator exemple pour le
locale donnée avec -lieu (ou les paramètres régionaux par défaut).

Cette option doit être spécifiée lors de l'application gjdoc au code source commenté dans un
langue latine pour laquelle le détecteur de première phrase par défaut ne fonctionne pas. Pour tous
dans les autres cas, la valeur par défaut (ne pas utiliser BreakIterator) produit de meilleurs résultats au
moment de cette écriture.

Interconnexion avec autre Documentation Sets

-lien url
Créez des hyperliens vers un autre ensemble de documentation.

Par défaut, gjdoc créera uniquement des hyperliens vers les classes de l'ensemble source. Utilisez ceci
option pour créer en plus des hyperliens vers les classes couvertes par le
ensemble de documentation.

url doit être l'URL racine de l'autre ensemble de documentation. Par exemple, pour ajouter
hyperliens vers GNU Classpath, spécifiez les éléments suivants :

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

La -lien L'option peut être spécifiée plusieurs fois.

Notez qu'en spécifiant le -lien L'option provoquera un accès HTTP à chaque fois que gjdoc est
invoqué. Vous pouvez utiliser -lienhors ligne au lieu d'éviter cet accès.

-lienhors ligne url filet
Créer des hyperliens vers un autre ensemble de documentation qui est également présent sur le fichier local
système.

Cette option fonctionne exactement comme -lien, sauf qu'il accède au système de fichiers local
au lieu du réseau pour déterminer quelles classes sont couvertes par le lien
ensemble de documentation.

Lors de l'utilisation -lienhors ligne l'ensemble de documentation à distance n'est pas accessible du tout, ce qui peut
accélérer considérablement le temps de génération en fonction de votre connexion réseau. Les
les hyperliens générés vers l'ensemble de documentation se réfèrent cependant à l'ensemble distant, pas à
le local, afin que vous puissiez distribuer la documentation sans autre
dépendances.

La -lienhors ligne L'option peut être spécifiée plusieurs fois.

-pas de qualificatif paquet:paquet:...
Ne qualifiez pas les noms de classes dans les packages donnés avec leur nom de package.

Par défaut, un nom de classe est affiché non qualifié uniquement si la classe fait partie du
ensemble source ou un ensemble de documentation lié, et qualifié avec le nom de son
contenant le paquet si ce n'est pas le cas. Vous pouvez utiliser cette option pour forcer les noms non qualifiés
pour les classes même si elles ne font pas partie de la documentation.

Par exemple, généralement une référence à la classe String est représentée entièrement qualifiée comme
java.lang.String (sauf si vous créez un lien vers l'ensemble de documentation approprié en utilisant -lien)
car il ne fait pas partie de la documentation. Vous pouvez spécifier -pas de qualificatif
java.lang rendre les mêmes références tout comme Chaîne.

Notez que pour tous les noms de classe non qualifiés, une info-bulle est fournie lorsque vous placez votre
pointez la souris dessus dans la documentation HTML.

-pas de qualificatif TOUTE
Omettez le qualificateur de nom de package de tous les noms de classe.

Spécifiez cette option pour omettre complètement les qualificatifs de nom de package,

Sélection qui Informations à Générer

-Publique
Incluez uniquement les membres publics des classes publiques dans la sortie. Par défaut, protégé
les membres du groupe sont également inclus.

-protégé
Incluez les membres publics ou protégés des classes publiques dans la sortie. C'est le
défaut.

-paquet
Inclure les membres public, protected et package-private de public et package-private
classes.

-privé
Incluez toutes les classes et tous les membres de la classe, quel que soit leur niveau d'accès.

-index divisé
Générez une page d'index par lettre au lieu d'une seule page d'index monolithique.

Par défaut, l'index créé par le doclet standard contient toutes les entrées sur un seul
page. C'est bien pour les petits ensembles de documentation, mais pour les grands ensembles, vous devriez
spécifiez cette option.

-nos depuis
ignorer @puisque balises dans les commentaires javadoc.

Par défaut, la sortie générée contient des sections répertoriant la version de votre API
depuis lequel le package, la classe ou le membre de classe en question existe lorsque cette balise est
rencontré. Spécifiez cette option pour omettre ces informations.

-notrearbre
Ne générez aucune page d'arborescence.

Par défaut, la sortie générée comprend un arbre d'héritage par package, et - si
l'ensemble de documentation se compose de plusieurs packages - une page avec l'héritage complet
arbre. Spécifiez cette option pour omettre la génération de ces pages.

-noindex
Ne pas sortir l'index alphabétique.

Par défaut, gjdoc génère un index alphabétique de tous les éléments du programme dans le
ensemble de documentation (paquets, classes, classes internes, constructeurs, méthodes et
des champs). Spécifiez cette option pour omettre ces informations.

-pas d'aide
Ne générez pas la page d'aide.

Cette option est actuellement ignorée car le doclet standard ne fournit pas de page d'aide.

-nodedéprécié
Ne produisez pas d'informations en ligne sur les packages, les classes ou les membres de classe obsolètes.

Par défaut, le doclet standard ajoute un paragraphe en surbrillance avec dépréciation
informations à la description de chaque élément de programme obsolète. Précisez ceci
possibilité d'omettre ces informations.

-nodeprecatedlist
N'affichez pas la page de résumé pour les éléments d'API obsolètes.

Par défaut, le doclet standard génère une page répertoriant tous les éléments d'API obsolètes
ainsi qu'une description de la dépréciation qui inclut généralement la raison de la dépréciation
et les alternatives possibles. Spécifiez cette option pour omettre ces informations.

-nonavbar
Ne pas afficher la barre de navigation, l'en-tête et le pied de page.

Par défaut, chaque page de sortie est équipée d'une barre de navigation supérieure (qui peut inclure
un en-tête spécifié par l'utilisateur) et une barre de navigation inférieure (qui peut inclure un
pied de page spécifié). Spécifiez cette option pour omettre cette décoration.

-sans commentaire
Omettez tout le texte de la documentation des fichiers générés et n'affichez que les déclarations et
relations entre les éléments du programme.

Cette option est ici pour la compatibilité avec Javadoc. Si vous prévoyez d'extraire
informations sur votre projet via gjdoc, vous devriez envisager d'utiliser un autre Doclet
pour vos besoins à la place, par exemple XmlDoclet. Vous pouvez également utiliser l'API Doclet
directement en implémentant un nouveau Doclet.

-liensource
Générez une page avec un code source mis en évidence par la syntaxe pour chaque classe. Par défaut, ce
la page n'est pas générée.

Le code source est accessible en cliquant sur le bouton intitulé "Source" dans le
barre de navigation, ou en cliquant sur le nom d'un constructeur, d'un champ, d'une méthode ou d'un
class dans la section détaillée d'une page de documentation de classe.

-utiliser
Générez une page avec des informations de référence croisée. Par défaut, cette page n'est pas
généré.

Les informations de références croisées sont accessibles en cliquant sur le bouton intitulé
« Utiliser » dans la barre de navigation.

La page « Use » répertorie toutes les classes/interfaces dans l'ensemble de documentation qui
étendre/mettre en œuvre la classe (type) en question ; champs du type; méthodes ou
constructeurs acceptant un paramètre du type ; méthodes renvoyant le type ; et
méthodes ou constructeurs lançant le type.

-auteur
Incluez les informations sur l'auteur dans la sortie.

Lorsqu'elles sont spécifiées, les informations sur l'auteur telles que spécifiées à l'aide de la @auteur balise en javadoc
les commentaires sont intégrés à la sortie. Par défaut, @auteur les balises sont ignorées.

-version
Incluez les informations de version dans la sortie.

Lorsqu'elles sont spécifiées, les informations de version telles que spécifiées à l'aide de la @version balise en javadoc
les commentaires sont intégrés à la sortie. Par défaut, @version les balises sont ignorées.

-texte de la licence
Supposons que le premier commentaire de chaque fichier source contienne le texte de la licence et ajoutez
informations de licence dans le pied de page de chaque page de classe générée.

Il s'agit d'une option spécifique à gjdoc et non compatible avec Sun Javadoc.

Cette option est destinée à être utilisée avec des projets libres et open source où le code source
est généralement précédé d'un commentaire de licence passe-partout, lorsqu'il existe des raisons juridiques
pour inclure la licence dans la documentation.

-docfilessous-répertoires
Copiez récursivement tous les fichiers du fichiers doc sous-répertoire de chaque répertoire de package.

En général, seuls les fichiers du fichiers doc sous-répertoire sont copiés sans descendre
récursivement.

-sous-répertoire de fichiers occlus prénom:prénom: ...
Ne copiez pas certains répertoires directement sous le fichiers doc sous-répertoires lorsque
descendant récursivement.

L'argument de cette option doit être une liste de noms de répertoires séparés par des deux-points.

Cette option n'a de sens que si -docfilessous-répertoires est également précisé. Dans ce cas, tout
sous-répertoire situé directement sous un fichiers doc répertoire est omis s'il est répertorié.

Coutume Documentation Tags

-chemintaglet liste de chemins
Rechercher liste de chemins lors du chargement des classes Taglet suivantes spécifiées à l'aide -étiquette.

liste de chemins doit être un ou plusieurs chemins vers un répertoire ou un fichier jar, séparés par votre
le séparateur de chemin de la plate-forme (généralement : or ;).

-étiquette nom du cours
Enregistrez un Taglet.

nom du cours doit être le nom complet d'une classe Java implémentant
com.sun.tools.doclets.Taglet.

Les classes Taglet seront chargées à partir du chemin de classe spécifié à l'aide de -chemintaglet, de
le chemin de classe spécifié à l'aide -chemin de classe et du chemin de classe par défaut.

Voir la documentation de com.sun.tools.doclets.Taglet pour plus d'informations.

Notez que pour les balises simples, il existe également -marque.

-marque spécif de balise
Enregistrez un Taglet générique.

Le format de spécif de balise doit être : :" ".

nom de balise est le nom de la balise à faire correspondre, sans le signe @ en tête.

drapeaux est un ou plusieurs des caractères suivants, où chaque caractère spécifie un
contexte du code source dans lequel la balise doit être reconnue.

a tous les contextes

c constructeurs

f des champs

m méthodes

o vue d'ensemble

p Forfaits

t types (classes, interfaces, exceptions, erreurs)

X caractère spécial qui désactive temporairement le Taglet.

tête de balise est la chaîne à afficher dans l'en-tête de la section consacrée à la balise dans
question.

Par exemple, pour définir une balise correspondant @cvsid qui doit être accepté en vue d'ensemble,
pages de package et de type et qui est étiqueté avec l'en-tête CVS ID, tu le ferais
spécifier:

-tag cvsid:tpo:"ID CVS"

Disons qu'un commentaire javadoc de classe contient

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

Ensuite, la sortie HTML contiendra quelque chose comme

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

Fonctionnement Autre doclets

-chemindoclet liste de chemins
Rechercher liste de chemins lors du chargement des classes pour le Doclet spécifié à l'aide -doclet.

liste de chemins doit être un ou plusieurs chemins vers un répertoire ou un fichier jar, séparés par votre
le séparateur de chemin de la plate-forme (généralement : or ;).

-doclet nom du cours
Exécutez le doclet spécifié au lieu du HtmlDoclet standard.

nom du cours devrait être le nom complet d'une classe qui a une valeur par défaut publique
constructeur et contiennent une méthode avec la signature suivante :

importer com.sun.javadoc.RootDoc ;
démarrage booléen statique public (RootDoc ​​rootDoc)

Les classes Doclet seront chargées à partir du chemin de classe spécifié à l'aide de -chemindoclet, de
le chemin de classe spécifié à l'aide -chemin de classe et du chemin de classe par défaut.

La Commencer doit traiter les informations exposées par l'API Doclet via racineDoc
et retour oui en cas de réussite, non en cas d'échec.

Si vous utilisez un doclet tiers, reportez-vous à sa documentation pour plus d'informations
instructions. Notez que la prise en charge des doclets tiers est expérimentale. S'il te plaît
signaler tout problème que vous rencontrez ou fournir des commentaires lors de l'exécution réussie
applets tiers.

Cette option peut être spécifiée plusieurs fois, auquel cas tous les doclets sont exécutés
avec la même arborescence d'informations exposée via l'API Doclet pour chaque exécution de Doclet.

L'ajout de Informations à le Sortie

-titre de la fenêtre texte
Utilisez texte comme préfixe du titre de la fenêtre du navigateur.

Lorsqu'il est spécifié, le titre de la fenêtre du navigateur pour chaque page sera préfixé par texte
au lieu de la chaîne par défaut Création API Documentation.

texte doit être en texte brut (il ne doit pas contenir de balises HTML).

-titredoc texte
Définissez le texte de l'en-tête de la page d'aperçu sur texte.

texte doit être une courte chaîne de texte brut.

Lors de la génération de la documentation pour un seul package, la spécification de cette option force
génération de la page d'aperçu.

-entête texte html
Ajouter texte html dans le coin supérieur droit de chaque page générée. texte html est généralement
défini sur le nom du projet en cours de documentation.

-bas de page texte html
Ajouter texte html dans le coin inférieur droit de chaque page générée. texte html est souvent
mis à la même valeur que pour -entête.

-bas texte html
Ajouter texte html tout en bas de chaque page générée, couvrant toute la largeur de
la page. Lorsque spécifié, texte html consiste généralement en un avis de droit d'auteur et/ou
des liens vers d'autres pages du projet.

-ajouter une feuille de style filet
Augmenter les feuilles de style CSS par défaut avec la feuille de style spécifiée par l'utilisateur filet.

La feuille de style donnée est simplement chargée par chaque page HTML en plus de la feuille de style par défaut
ceux, comme la dernière feuille de style.

Notez que les règles de cascade CSS s'appliquent. C'est-à-dire que vos propriétés de style ne seront
attribués s'ils ont un ordre en cascade plus élevé que gjdocle style par défaut. un simple
le moyen de s'assurer que c'est le cas est de déclarer vos dérogations !important.

Voirhttp://www.w3.org/TR/REC-CSS2/cascade.html#commande-en-cascade>.

-groupe titre pkgwildcard:pkgwildcard: ...
Organisez les packages donnés dans un groupe séparé sur la page de présentation.

Le premier argument doit être un court texte clair qui est utilisé comme titre du
groupe de paquets. Le deuxième argument doit être une liste de packages séparés par des deux-points
caractères génériques. Le groupe sera composé de tous les packages de l'ensemble de documentation dont le nom
correspond à l'un des caractères génériques donnés.

Il n'y a qu'un seul caractère générique, *, qui correspond aux deux lettres du nom du package
composants et le . séparer les composants du nom du package. Par exemple, j*regex pourra
paquet de correspondance java.util.regex. Un exemple plus utile serait javax.swing* faire correspondre
javax.swing et tous ses sous-ensembles.

Cette option peut être donnée plusieurs fois.

FIXME : informations sur l'imbrication de groupe ici.

gjdoc -group "Classes de base" 'java*' \
-group "Swing" 'javax.swing*' \
-group "API XML" 'javax.xml*' \
-group "Autres extensions" javax* \


-Aperçu filet
Ajoutez le fragment de corps XHTML de filet à la page d'aperçu.

filet doit contenir un fragment XHTML avec le HTML corps tag comme nœud racine.

Cette option peut être utilisée pour fournir une description de l'ensemble de la documentation dans son ensemble.

Lorsque spécifié, la première phrase du fragment sera placée au-dessus des tableaux
répertoriant les packages documentés, ainsi qu'un lien vers la copie complète du fragment
qui est mis en dessous des tableaux.

Lors de la génération de la documentation pour un seul package, la spécification de cette option force
génération de la page d'aperçu.

-fichier de feuille de style filet
Utilisez la feuille de style CSS dans filet au lieu des feuilles de style CSS par défaut.

Si vous souhaitez uniquement remplacer des parties des feuilles de style par défaut, utilisez -ajouter une feuille de style
à la place.

-Titre texte
Obsolète. Utilisez -titredoc texte à la place.

-fichier d'aide filet
Cette option est actuellement ignorée.

Une fois implémenté, il utilisera le fragment XHTML dans filet pour le contenu de la page d'aide
au lieu du texte d'aide par défaut.

Contrôle le Sortie.

-d annuaire
Placez tous les fichiers de sortie dans annuaire (et sous-répertoires). annuaire sera créé
s'il n'existe pas, y compris tous les répertoires parents non existants et tous les répertoires requis
sous-répertoires.

Si non spécifié, la sortie sera placée dans le répertoire courant.

-lieu prénom
Utiliser les paramètres régionaux prénom au lieu des paramètres régionaux par défaut à toutes fins utiles.

prénom devrait être un spécificateur de paramètres régionaux sous la forme ll_CC[_VAR] De ll est un deux minuscules-
lettre ISO-639 code de langue, CC est un pays ISO-3166 à deux lettres majuscules facultatif
code, et VAR est un code de variante facultatif. Par exemple, en précise l'anglais, en_US
spécifie l'anglais américain, et fr_US_WIN spécifie une variante déviante de l'anglais américain
Local.

Notez que la sémantique de cette option correspond exactement à celle des constructeurs
de classe java.util.Locale.

Cette option ne détermine actuellement que l'assembleur utilisé pour trier la sortie
éléments. Cela signifie que les paramètres régionaux n'auront d'effet que si vous utilisez des
Caractères ASCII dans les identifiants.

-jeu de caractères jeu de caractères
Obsolète. Remplacer l'encodage spécifié dans les fichiers XHTML de sortie avec celui donné
by jeu de caractères.

Si cette option n'est pas donnée, la spécification d'encodage dans le XHTML de sortie est choisie pour
correspondent à l'encodage utilisé lors de l'écriture du fichier (l'encodage donné avec -docencodage,
ou l'encodage par défaut de votre plateforme).

La sémantique de jeu de caractères sont spécifiés ici :
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. À toutes fins pratiques,
elles sont identiques à celles des autres options acceptant les paramètres charset.

Cette option est ici pour la compatibilité avec Javadoc et doit être évité.

-docencodage jeu de caractères
Utilisez l'encodage du jeu de caractères donné lors de l'écriture des fichiers de sortie au lieu de celui de votre plate-forme
encodage par défaut.

Exemples pour jeu de caractères US-ASCII, ISO-8859-1 or UTF-8.

La sémantique de cette option correspond exactement à celle des constructeurs de la classe
java.util.Locale.

-validhtml
Forcer la génération de code XHTML valide. Cela rompt la compatibilité avec le traditionnel
outil Javadoc dans une certaine mesure.

Si cette option est spécifiée, les noms d'ancre seront modifiés afin qu'ils soient valides
selon la spécification XHTML 1.1. Cependant, un ensemble de documentation généré avec
cette option ne peut pas être liée à l'utilisation correcte de l'outil Javadoc traditionnel. Ça peut
être lié à très bien en utilisant Gjdoc, cependant.

Sans cette option, les noms d'ancre pour les membres de la classe exécutable utilisent le traditionnel
format, par exemple : "foo(String,int[])". Ceci est compatible avec le traditionnel
outil Javadoc, mais selon les spécifications HTML 4.0 et XHTML 1.0 et 1.1,
ce format inclut des caractères illégaux. Parenthèses, crochets et virgule
ne sont pas autorisés dans les noms d'ancre.

-baseurl url
Câblage d'une URL de page relative à url dans chaque page générée.

Si vous générez une documentation qui sera exclusivement disponible à un certain
URL, vous devez utiliser cette option pour spécifier cette URL.

Cela peut aider à éviter certaines attaques de redirection utilisées par les spammeurs, et cela peut être utile
pour certains clients Web.

Verbosité Options

-silencieux
Supprime toutes les sorties, à l'exception des avertissements et des messages d'erreur.

-verbeux
Soyez très verbeux sur ce que gjdoc fait.

Cette option est actuellement ignorée.

Salle de conférence virtuelle Machine Options

Soleil Javadoc l'outil semble être basé sur javac et en tant que tel, il semble fonctionner sur la VM
niveau. gjdoc, en revanche, est une application Java pure.

Par conséquent, gjdoc ne peut que simuler ou simuler les options suivantes au niveau de la machine virtuelle.

-chemin de classe liste de chemins
Définir la machine virtuelle chemin de classe à liste de chemins.

Dans la plupart des cas, vous devez utiliser -chemindoclet or -chemintaglet au lieu de cette option.

liste de chemins doit être un ou plusieurs chemins vers un répertoire ou un fichier jar, séparés par votre
le séparateur de chemin de la plate-forme (généralement : or ;).

Si cette option n'est pas interceptée au niveau du wrapper, gjdoc le simule actuellement en
appel System.setProperty("java.class.path", liste de chemins); et émet un avertissement.

-chemin de classe de démarrage liste de chemins
Définir la machine virtuelle chemin de la classe d'amorçage à liste de chemins.

Si cette option n'est pas interceptée au niveau du wrapper, gjdoc émet un avertissement.

-Jvmopt
Passer un paramètre arbitraire à la machine virtuelle gjdoc fonctionne sur.

Si cette option n'est pas interceptée au niveau du wrapper, gjdoc essaie d'imiter le
option et génère un avertissement.

Actuellement, seule l'option VM -D pour définir les propriétés du système est émulé.

Utilisez gjdoc-4.8 en ligne à l'aide des services onworks.net