Object: Read documentation
The module reads the XML and also the text documentation of objects. It will be printed in the report of the module. Empty elements of the structured documentation will not be shown
Designation
- Name
- info.DocumentationRead
- Aliases
- ObjectDocumentationRead
Configuration
- Optionen
- Type (
type) - Defines the documentation typeMögliche Werte: Text (
text), XML (xml)
- XML node (
xml-node) - Path to the XML node
- Pattern (
pattern) - A regular expression used as the anchor for the modes 'Before pattern', 'After pattern' and 'Replace pattern'
- Support multiline matching (
multiline) - Activates the support for regular expressions matching multiple lines
- show matched documentation fragment only (
matched-only) - If set just the matched part of the text documentation or XML node value is shown
- Output directory (
output-dir) - The found objects are written to files in the given directory
Description
If Text is selected as the documentation type, it is possible to write the documentation found to files. To do this, an output directory must be specified in which the files are stored. If the directory does not exist, it is created by the module. Files with the naming scheme <object name>.<name of documentation tab> are then stored in the directory. This means that there will be a separate file for each documentation tab of an object.
To change the documentation, the