Expert Générer la documentation

De RAD Studio
Aller à : navigation, rechercher

Remonter à Gestion des projets


Vous pouvez utiliser l'expert Générer la documentation pour générer la documentation HTML de vos projets de modélisation. Pour ouvrir cette boîte de dialogue, activez la Vue Modèle ou la Vue Diagramme et choisissez Outils > Options > Modélisation > Générer la documentation depuis le menu principal ou Générer la documentation depuis le menu contextuel.

L'expert Générer la documentation a les contrôles suivants :

Contrôle Description

Options de portée

Vous pouvez limiter la portée de la documentation à un ensemble plus restreint en choisissant une option de portée différente. La section Portée en haut de la boîte de dialogue comporte des boutons radio qui vous permettent d'indiquer les parties du projet devant être analysées et incluses dans la documentation générée :

  • Espace de nommage en cours -- La sortie générée ne comprend que l'espace de nommage sélectionné dans la vue Modèle ou dans la vue Diagramme.
  • Espace de nommage en cours avec espaces de nommage descendants -- La sortie générée comprend l'espace de nommage sélectionné dans la vue Modèle et tous les espaces de nommage descendants sous lui.
  • Diagramme en cours -- La sortie générée pour le diagramme en cours qui détient la focalisation dans la vue Diagramme.
  • Tous -- La sortie générée couvre la totalité du projet.

Paramètres Options

La section Options de la boîte de dialogue vous permet de spécifier la destination et d'autres options facultatives :

  • Dossier de sortie -- Entrez l'emplacement de la sortie générée ou sélectionnez-le à l'aide du sélecteur de fichier.
  • Inclure les diagrammes -- Cochez cette option pour inclure des images de diagramme dans la sortie.
  • Inclure l'arborescence de navigation -- Cochez cette option pour inclure une arborescence de navigation dans la sortie.
  • Lancer le navigateur HTML -- Cochez cette option pour charger la documentation dans votre navigateur web externe.

Remarque : Le cadre de navigation de la documentation ne fonctionnera que si JDK/JRE 1.4 est installé et activé dans votre navigateur.

OK

Valide toutes les saisies et démarre le processus de génération de la documentation.

Annuler

Ignore toutes les saisies et ferme la boîte de dialogue sans générer la documentation.

Voir aussi