Dokumentation generieren (Dialogfeld)
Nach oben zu Dialogfelder für die Modellierung - Index
Die Modellierung bietet einen UML-Dokumentationsexperten, mit dem Sie HTML-Dokumentation für Ihre Projekte erzeugen können. Um dieses Dialogfeld zu öffnen, wählen Sie im Hauptmenü . Zusätzlich zu dieser Hilfe verfügen die Modellierungs-Dialogfelder über integrierte Hilfetexte.
|
Bereich |
Sie können den Bereich, für den die Dokumentation erstellt werden soll, eingrenzen, indem Sie die entsprechende Bereichsoption auswählen. Mit den Optionsfeldern unter Bereich (im oberen Teil des Dialogfelds) geben Sie an, welche Teile des Projekts analysiert und in die Dokumentationserzeugung einbezogen werden. Aktueller Namespace -- Die Dokumentationserzeugung erfolgt nur für den aktuellen Namespace, der in der Modellansicht oder Diagrammansicht ausgewählt ist. Aktueller Namespace mit abgeleiteten Namespaces -- Die Dokumentationserzeugung erfolgt für den aktuellen Namespace, der in der Modellansicht ausgewählt ist, sowie für alle von ihm abgeleiteten Namespaces. Aktuelles Diagramm -- Die Dokumentationserzeugung erfolgt für das aktuelle Diagramm, das in der Diagrammansicht den Fokus besitzt. Alles -- Die Dokumentationserzeugung erfolgt für das gesamte Projekt. |
|
Optionen |
Der Bereich Optionen des Dialogfelds enthält Einstellungen, mit denen Sie das Ziel sowie weitere Aktionen festlegen können: Ausgabeordner -- Geben Sie den Speicherort für die erzeugte Ausgabe ein, oder wählen Sie ihn mit Hilfe der Dateiauswahl. Diagramme einbeziehen -- Wenn Sie dieses Kontrollkästchen aktivieren, enthält die Ausgabe Diagrammbilder. Navigationshierarchie einbeziehen -- Wenn Sie dieses Kontrollkästchen aktivieren, enthält die Ausgabe eine Navigationshierarchie. HTML-Browser aufrufen -- Aktivieren Sie dieses Kontrollkästchen, um die Dokumentation in den externen Web-Browser zu laden. Hinweis: Der Navigations-Frame in der Dokumentation funktioniert nur, wenn JDK/JRE 1.4 installiert und im Browser und aktiviert ist. |
|
OK |
Die Eingaben werden übernommen, und die Erzeugung der Dokumentation wird gestartet. |
|
Abbrechen |
Die Eingaben werden verworfen, das Dialogfeld wird geschlossen, und die Dokumentation wird nicht generiert. |