Génération Javadoc

L'assistant Génération Javadoc permet de générer Javadoc. Il s'agit de l'interface utilisateur de l'outil javadoc.exe disponible dans le JDK Java. Pour consulter la documentation complète de l'outil Javadoc, reportez-vous à la page Sun's Javadoc Tool.

Première page

Sélection du type :

Option	Description
Commande Javadoc	Indique la commande à utiliser pour générer Javadoc.
Sélectionnez des types pour la génération Javadoc.	Dans cette liste, cochez ou décochez les cases pour spécifier exactement les types à exporter. Le contenu initial de cette liste dépend de la sélection effectuée dans le plan de travail.
Créer un Javadoc pour les membres avec visibilité	Privée : Tous les membres seront documentés. Package: seuls les membres avec une visibilité publique, protégée ou package seront documentés. Protégée : Seuls les membres avec une visibilité protégée ou publique seront documentés. Publique : Seuls les membres avec une visibilité publique seront documentés (valeur par défaut).
Utiliser un doclet standard	Permet de lancer la commande Javadoc avec le doclet standard (valeur par défaut). Destination : Sélectionnez la destination à laquelle le doclet standard enregistrera la documentation générée. La destination est un argument spécifique de doclet et n'est donc pas activée lorsqu'un doclet personnalisé est utilisé.
Utiliser un doclet personnalisé	Permet d'utiliser un doclet personnalisé pour générer la documentation. Nom du doclet : Nom de type complet du doclet. Chemin d'accès au doclet : Chemin d'accès aux classes requis par la classe de doclet.

Arguments pour doclet standard

Arguments pour doclet standard (disponible lorsque l'option Utiliser un doclet standard est sélectionnée).

Option	Description
Titre du document :	Indiquez un titre de document.
Générer la page d'utilisation	Sélectionnez cette option pour que la documentation contienne une page d'utilisation.
Générer l'arborescence de hiérarchie	Sélectionnez cette option pour que la documentation contienne une page Arborescence.
Générer la barre de navigation	Sélectionnez cette option pour que la documentation contienne une barre de navigation (en-tête et pied de page).
Générer l'index	Sélectionnez cette option pour que la documentation contienne une page Index.
Séparer l'index par des lettres	Créez un index par lettre. Cette option est activée lorsque Générer l'index est sélectionné.
@auteur	Sélectionnez cette option pour que l'indicateur @auteur soit documenté.
@version	Sélectionnez cette option pour que l'indicateur @version soit documenté.
@déconseillés	Sélectionnez cette option pour que l'indicateur @déconseillés soit documenté.
liste déconseillée	Sélectionnez cette option pour que la documentation contienne une page Déconseillés. Cette option est activée lorsque l'option @déconseillés est sélectionnée.
Sélectionnez les archives référencées et les projets pour lesquels des liens doivent être générés	Indiquez les autres documentations Javadoc avec lesquels des liens doivent être créés lorsque d'autres types sont référencés. Sélectionner tout : Crée des liens avec tous les autres emplacements de documentation. Effacer tout : Ne crée pas de liens avec les autres emplacements de documentation. Configurer : Permet de configurer l'emplacement Javadoc d'un fichier JAR ou d'un projet référencé.
Feuille de style	Permet de sélectionner la feuille de style à utiliser.

Arguments généraux

Options Javadoc générales :

Option	Description
Présentation	Indique que Javadoc doit extraire le texte de documentation générale à partir du fichier donné. Ce texte sera placé dans le fichier overview-summary.html.
Options VM	Ajoutez ici toutes les options VM supplémentaires.
Options Javadoc supplémentaires	Ajoutez ici toutes les options supplémentaires : options de doclet personnalisé ou de compatibilité JRE 1.4. Les arguments contenant des espaces doivent être placés entre guillemets. Pour les arguments qui indiquent du code html (par exemple -header), utilisez & ou &" à la place des espaces et des guillemets.
Compatibilité de source JRE	Compatibilité de source JRE que doit admettre l'outil javadoc.
Sauvegardez les paramètres de cette exportation Javadoc sous la forme d'un script Ant.	Indiquez de stocker un script Ant qui effectuera l'exportation Javadoc indiquée sans qu'il soit nécessaire d'utiliser l'assistant. Le script Ant existant peut être modifié avec cet assistant. (Sur le script Ant généré, sélectionnez Ouvrir l'assistant Javadoc dans le menu contextuel.)
Ouvrir le fichier d'index généré dans le navigateur	Permet d'ouvrir le fichier index.html généré dans le navigateur (disponible uniquement lorsque le doclet standard est utilisé)

Cliquez sur Terminer pour lancer la génération de Javadoc. Si la destination est différente de l'emplacement configuré, la page Emplacement Javadoc, vous serez invité à choisir le nouveau dossier de destination comme l'emplacement Javadoc du projet. La documentation créée sera alors utilisée pour toutes les demandes d'ouverture de Javadoc.

Un nouveau processus sera lancé et la génération sera effectuée en arrière-plan. Ouvrez la vue Console (Fenêtre > Afficher la vue > Console) pour afficher la progression et l'état de la génération.

Référence connexe

Actions sur les fichiers
Propriétés de l'emplacement Javadoc