Sie sind hier: Dokumentieren > AutoDoc-Funktionen
Close
Doc-O-Matic 10
AutoDoc-Funktionen

Beim Schreiben Ihrer Dokumentation können Sie AutoDoc-Funktionen verwenden. Diese Funktionen erzeugen Dokumentation für bestimmte Symbole erstellen Überblicksseiten und Hyperlinks mit Themen-IDs. AutoDoc-Funktionen umfassen:

  • Überladene Funktionen mit Ihrer "Basis"- Funktion kombinieren, wenn die Basisfunktion dokumentiert ist und die überladenen Funktionen nicht.
  • Erzeugen von Ordnern für überladene Funktionen.
  • Erzeugen von Themen für Ordner und Überblicksseiten.
  • Ein Alias für Typedef-Strukturen erzeugen und den Typen-Teil von Typdef-Strukturen in das Strukturenordner einordnen.
  • Text für Members von geerbten Symbolen kopieren, wenn diese verfügbar sind und es keine Beschreibung für das Member gibt.
  • Zusammenfassungen vom ersten Satz des Kommentars erzeugen. Um diese Funktionen zu verwenden, aktivieren Sie das Kontrollkästchen neben automatischer Abschnitt auf der Seite [General Settings] > Documentation > Automatic Text.
  • Automatisch Hyperlinks von Worten und Symbolnamen zu anderen Themen der Dokumentation erzeugen.
  • Text zu undokumentierten Symbolen hinzufügen. Der Text kann frei eingestellt werden. Weitere Informationen hierzu finden Sie in Ändern von automatisch erzeugtem Text.
  • Die Deklaration und wahlweise die Implementierung zum Thema hinzufügen. Weitere Informationen finden Sie in Darstellung des Sourcecodes.
  • Überblicke (zum Beispiel für Members von Klassen) und Klassenhierarchien für die Ausgabe erzeugen. Weitere Informationen finden Sie in Überblicksseiten.

Zusätzlich gibt es verschiedenste AutoDoc-Funktionen, die Sie dabei unterstützen optionale zusätzliche Teile für Ihre Dokumentation zu erstellen. Sie können:

C++-Analyseoptionen, Themenverarbeitung, Automatischer Thementext, AutoDoc-Inhalt, Inhaltsoptionen, Automatischer Abschnitt, Hyperlinks

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