Modellierung - Optionen für die Dokumentationserzeugung
Inhaltsverzeichnis
Nach oben zu Modellierungsoptionen
Tools > Optionen > Modellierung > (Ebene) > Dokumentation generieren
- Hier wird mit (Ebene) angegeben, dass die Optionsseite Dokumentationserzeugung in den Zweigen Projekt, Projektgruppe und Vorgabe der Modellierungs-Optionshierarchie ausgewählt werden kann. (Siehe Hierarchische Ebenen der Modellierungsoptionen im Dialogfeld Modellierungsoptionen für weitere Informationen).
Mit den Optionen für die Dokumentationserzeugung wird eine Vielzahl an Inhalten überprüft, die in die erzeugte HTML-Dokumentation über die Diagramme aufgenommen oder ausgeschlossen werden soll. Damit wird auch festgelegt, wie die einbezogenen Elemente in die erzeugte Dokumentation angezeigt werden sollen.
Optionen für die Dokumentationserzeugung
Option | Beschreibung und Vorgabewert |
---|---|
Unten |
Legt den Text fest, der unten in jede generierte Dokumentationsdatei platziert werden soll. |
Titel der Dokumentation |
Legt den Titel fest, der oben in der generierten Übersichtsdatei angezeigt werden soll. |
Fußzeilentext |
Legt den Fußzeilentext fest, der in jede generierte Dokumentationsdatei platziert werden soll. |
Kopfzeilentext |
Legt den Kopfzeilentext fest, der in jede generierte Dokumentationsdatei platziert werden soll. |
Navigationstyp |
Definiert, wo Beschreibungen der Designelemente platziert werden sollen:
Der Vorgabewert ist |
Internen Browser verwenden |
|
Fenstertitel |
Legt den Titel fest, der in das HTML-Tag |
Optionen der Gruppe Einbeziehen
Option | Beschreibung und Vorgabewert |
---|---|
internal (Package) |
|
private |
|
protected |
|
protected internal |
|
public |
|
Option | Beschreibung und Vorgabewert |
---|---|
Hilfe generieren |
Steuert, ob der Link Hilfe in die Navigationsleisten oben und unten auf allen Seiten aufgenommen werden soll. |
Index erzeugen |
Steuert, ob der Link Index in die Navigationsleisten oben und unten auf allen Seiten aufgenommen werden soll. |
Navigationsleiste, Kopf- und Fußzeile erzeugen |
Steuert, ob Navigationsleisten, Kopf- und Fußzeilen oben und unten auf allen erzeugten Seiten angezeigt werden. |
Hierarchie erzeugen |
Steuert, ob eine Klassen/Interface-Hierarchie erzeugt wird. |
Verwendungsseite generieren |
|