Modélisation - Options de génération de la documentation

Remonter à Catégories d'options de la modélisation - Index

Outils > Options > Modélisation > (niveau) > Générer la documentation

Ici > (niveau) > est utilisé pour spécifier que le groupe d'options Code source peut être sélectionné à plusieurs niveaux hiérarchiques de configuration de la modélisation. Les niveaux de configuration de la modélisation suivants peuvent être utilisés ici : Par défaut, Groupe de projets et Projet.

Les options de génération de la documentation contrôlent les divers contenus (ainsi que l'apparence) à inclure ou à exclure de votre documentation HTML générée.

Le tableau suivant liste les options du groupe Général :

Options	Description et valeur par défaut
Bas	Spécifie le texte à placer en bas de chaque fichier texte de sortie. Le texte apparaît en bas de la page, 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. Ce titre apparaît centré et 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 en bas de chaque fichier de sortie. Le pied de page apparaît à droite de la barre de navigation inférieure. Il peut contenir des balises HTML et des espaces.
Texte d'en-tête	Spécifie le texte d'en-tête à placer en haut de chaque fichier de sortie. L'en-tête apparaît à droite de la barre de navigation supérieure. Il peut contenir des balises HTML et des espaces.
Type de navigation	Spécifie l'emplacement des descriptions des éléments de conception. Package : dans les fichiers de packages. Diagramme : dans les fichiers de diagrammes. La valeur par défaut est Package.
Utiliser le navigateur interne	Si True, un navigateur interne est utilisé 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>. 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.

Le tableau suivant liste les options du groupe Inclusion :

Options	Description et valeur par défaut
internal (package)	Si True, les membres, les interfaces et les classes 'internal' sont présentés dans la documentation générée. La valeur par défaut est True.
private	Si 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	Si 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	Si 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	Si 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 True.

Le tableau suivant liste les options du groupe Navigation :

Options	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. 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"	Si 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, classes, méthodes, constructeurs et champs qui utilisent la classe ou l'espace de nommage donné. Pour une classe C donnée, les éléments utilisant la classe C incluent : les sous-classes de C, les champs déclarés en tant que type C, les méthodes renvoyant le type C, et les méthodes et les constructeurs ayant des paramètres de type C. La valeur par défaut est False.

Voir aussi

• Configuration de la modélisation UML
• Niveaux de configuration
• Editeurs des valeurs des options
• Macros système

• Boîte de dialogue Options de modélisation
  • Modélisation - Options d'apparence des diagrammes
  • Modélisation - Options de disposition des diagrammes
  • Modélisation - Options d'impression des diagrammes
  • Modélisation - Options de contrôle de l'affichage des diagrammes
  • Modélisation - Options générales
  • Modélisation - Options de la vue Modèle
  • Modélisation - Options de code source