Sie sind hier: AutoDoc und Formatieren > AutoDoc-Teile anpassen > Überblicksseiten und Abschnitte
Close
Doc-O-Matic 10
Überblicksseiten und Abschnitte

Doc-O-Matic erzeugt automatisch Übersichten über die einzelnen Symbole des Sourcecodes und die Themen der Dokumentation. In den Hilfesystemen wird diese Information sowohl in einem Abschnitt als auch auf eigenen Seiten angezeigt.

Überblicke

Es werden Überblicke über alle Unterthemen eines Themas wie zB alle Members, Variablen, Methoden und Typen erstellt. Die Members werden mit Ihrem Namen aufgelistet. Zusätzlich werden Ordner in den Überblicksseiten verwendet. Wenn Sie zum Beispiel einen Ordner für die Sortierung von Konstruktoren mit dem Namen Konstruktoren erstellt haben und den Konstruktor zu dieser Gruppierungsebene hinzugefügt haben, wird der Konstruktor im Überblick über alle Mitglieder im Abschnitt Konstruktoren aufgelistet. Weitere Informationen über Ordner finden Sie in Ordner

In der Standardeinstellung werden auch alle Mitglieder der Basisklasse in den Überblicken aufgelistet. Für Dateien wird ein Überblick über alle Klassen, Funktionen, Makros, Typen und Variablen der Datei erstellt (zum Beispiel Abschnitte Klassen, Variablen, Funktionen).

Klassenhierarchie

Doc-O-Matic erzeugt eine Klassenhierarchie für jede Klasse in Ihrem Projekt (Abschnitt Class Hierarchy oder Inheritance Hierarchy). Diese Klassenhierarchie können Sie als Grafik oder als Text anzeigen. Wahlweise können auch die abgeleiteten Klassen der aktuellen Klasse angezeigt werden. Weitere Informationen finden Sie in Lokale Klassenhierarchie.

Legende

Auf den Überblicksseiten und in den Überblicksabschnitten werden Symbole benutzt, um eine bestimmte Eigenschaft der aufgelisteten Elemente darzustellen (zum Beispiel, dass einen Funktion privat ist). Doc-O-Matic erzeugt Legenden, die die Bedeutung dieser Symbole erklären. In Doc-O-Matic gibt es verschiedenste Möglichkeiten Legenden anzuzeigen: Auf den Überblicksseiten, auf den Themenseiten unterhalb jedes Überblicksabschnittes oder in einem eigenen Überblicksabschnitt und auf einer eigenen Unterseite jeder Überblicksseite.

Member-Abschnitte

Für Members von Strukturen, Records und Aufzählungen erzeugt Doc-O-Matic einen Abschnitt Member. Weitere Informationen finden Sie auf der Seite Abschnitte Parameter, Rückgabewerte und Members.

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.