Remonter à Fenêtre de dialogue Options de modélisation
Outils > Options > Modélisation > (niveau) > Générer la documentation
- (niveau) est utilisé ici pour spécifier que la page (le groupe) Options de disposition des diagrammes peut être sélectionnée dans les branches Diagramme, Projet, Groupe de projets et Par défaut de la vue arborescente des options Modélisation. (Pour plus d'informations, consultez la rubrique Niveaux hiérarchiques des options de modélisation dans la boîte de dialogue Options de modélisation).
Les options Génération de la documentation contrôlent les divers contenus à inclure ou à exclure de votre documentation HTML générée, en décrivant des diagrammes et le mode d'affichage des éléments inclus dans la documentation générée.
Options Génération de la documentation
| Option
|
Description et valeur par défaut
|
|
Bas
|
Spécifie le texte du bas à placer dans chaque fichier de documentation généré.
Le texte sera présenté en bas, sous la barre de navigation inférieure.
Il peut contenir des balises HTML et des espaces.
|
|
Titre de la documentation
|
Spécifie le titre à placer en haut du fichier de présentation récapitulatif généré.
Le titre sera présenté centré, au niveau 1, immédiatement sous la barre de navigation supérieure.
Il peut contenir des balises HTML et des espaces.
|
|
Texte de pied
|
Spécifie le texte du pied de page à placer dans chaque fichier de documentation généré.
Le pied de page est présenté sur la droite de la barre de navigation inférieure.
Il peut contenir des balises HTML et des espaces.
Le pied de page est généré quand l'option Générer la barre de navigation, l'en-tête et le pied est définie sur True.
|
|
Texte de l'en-tête
|
Spécifie le texte de l'en-tête à placer dans chaque fichier de documentation généré.
L'en-tête est présenté sur la droite de la barre de navigation supérieure.
Il peut contenir des balises HTML et des espaces.
L'en-tête est généré quand l'option 'Générer la barre de navigation, l'en-tête et le pied' est définie sur True.
|
|
Type de navigation
|
Définit où placer les descriptions des éléments de conception :
Package -- dans les fichiers package.
Diagramme -- dans les fichiers diagramme.
La valeur par défaut est Package.
|
|
Utiliser le navigateur interne
|
True -- utilise le navigateur interne pour la présentation de la documentation.
La valeur par défaut est False.
|
|
Titre de fenêtre
|
Spécifie le texte du titre à placer dans la balise HTML <title> de chaque fichier de documentation généré.
Ce texte apparaît dans le titre de la fenêtre et dans les signets du navigateur (favoris) créés pour cette page.
Ce titre ne doit pas contenir de balises HTML, car les navigateurs ne peuvent pas les interpréter correctement.
|
Options du groupe Inclusion
| Option
|
Description et valeur par défaut
|
|
internal (package)
|
True -- les membres, les interfaces et les classes internal (package dans les projets de conception) sont présentés dans la documentation générée.
La valeur par défaut est True.
|
|
private
|
True -- les membres, les interfaces et les classes private sont présentés dans la documentation générée.
La valeur par défaut est False.
|
|
protected
|
True -- les membres, les interfaces et les classes protected sont présentés dans la documentation générée.
La valeur par défaut est False.
|
|
protected internal
|
True -- les membres, les interfaces et les classes protected internal sont présentés dans la documentation générée.
La valeur par défaut est False.
|
|
public
|
True -- les membres, les interfaces et les classes public sont présentés dans la documentation générée.
La valeur par défaut est False.
|
Options du groupe Navigation
| Option
|
Description et valeur par défaut
|
|
Générer l'aide
|
Contrôle s'il faut placer le lien Aide dans les barres de navigation en haut et en bas de chaque page.
La valeur par défaut est True.
|
|
Générer l'index
|
Contrôle s'il faut générer l'index dans les barres de navigation en haut et en bas de chaque page.
La valeur par défaut est True.
|
|
Générer la barre de navigation, l'en-tête et le pied
|
Contrôle s'il faut générer la barre de navigation, l'en-tête et le pied en haut et en bas des pages générées.
La valeur par défaut est True.
|
|
Générer l'arborescence
|
Contrôle s'il faut générer la hiérarchie classe/interface.
La valeur par défaut est True.
|
|
Générer la page Utilisation
|
True -- la page 'Utilisation' est générée pour chaque classe et espace de nommage documentés. Cette page liste les espaces de nommage, les classes, les méthodes, les constructeurs et les champs qui utilisent les éléments d'API de la classe ou du package donné.
Etant donné la classe C, les éléments qui utilisent la classe C incluent les sous-classes de C, les champs déclarés en tant que C, les méthodes qui renvoient C, ainsi que les méthodes et les constructeurs avec des paramètres de type C.
La valeur par défaut est False.
|
Voir aussi