Objekt: Dokumentation lesen

Das Modul liest die XML- oder auch Textdokumentation von Objekten aus. Diese werden im Bericht des Moduls ausgegeben. Leere Elemente der strukturierten Dokumentationn werden nicht angezeigt.

Bezeichnung

Name

info.DocumentationRead

Aliase

ObjectDocumentationRead

Konfiguration

Gruppe: Optionen

Typ (type)

Definiert den Typ der Dokumentation

Mögliche Werte: Text (text), XML (xml)

XML-Element (xml-node)

Pfad zum XML-Element

Muster (pattern)

Ein regulärer Ausdruck, der als Anker für die Modi ‚Vor dem Muster‘, ‚Hinter dem Muster‘ and ‚Ersetze Muster‘

Unterstütze mehrzeilige Übereinstimmung (multiline)

Aktiviert die Unterstützung für mehrzeilige Übereinstimmungen mit regulären Ausdrücken

Zeige nur zutreffende Dokumentationsfragmente (matched-only)

Ist die Option gesetzt, wird nur der mit dem regulären Ausdruck übereinstimmende Teil der Textdokumentation oder des XML-Knotens gezeigt

Ausgabeverzeichnis (output-dir)

Die gefundenen Objekte werden in Dateien in dem angegebenen Ordner geschrieben

Beschreibung

Wird als Dokumentationstyp Text ausgewählt ist es möglich die gefundene Dokumentation in Dateien zu schreiben. Dafür muss ein Ausgabeverzeichnis angegeben werden, in dem die Dateien abgelegt werden. Existiert das Verzeichnis nicht wird es durch das Modul angelegt. In dem Verzeichnis werden dann Dateien mit dem Namensschema <Objektname>.<Name des Dokumentationsreiter> abgelegt. Damit wird es für jeden Dokumentationsreiter eines Objektes eine eigene Datei geben.

Um die Dokumentation zu verändern kann das b4A-Modul ObjectDocumentationEdit verwendet werden.