README

XML2Markdown

XML2Markdown is a command-line tool that converts Delphi XMLDOC documentation files into Markdown format. It processes the XML documentation files generated by the Delphi compiler and produces clean, readable Markdown files.

Getting Started

Prerequisites

To generate XMLDOC files from your Delphi project:

1. Open your project options
2. Navigate to Building → Delphi Compiler → Compiling
3. Enable the "Generate XML documentation" checkbox

Usage

Basic syntax:

Xml2Markdown [/R] [/F] [/O output] [/H] pathname...

Parameters

• /R - Recursively convert files in the current directory and all subdirectories
• /F - Force overwrite if output files already exist
• /O output - Specify the output directory for the generated Markdown files
• /H - Display help information
• pathname - One or more files or directories to convert. If a directory is specified, the tool will process all XML files within it

Examples

Convert a single file:

Xml2Markdown MyUnit.xml

Convert all XML files in a directory and its subdirectories:

Xml2Markdown /R /O output_docs C:\MyProject\xmldocs

Force overwrite existing files:

Xml2Markdown /F /O docs MyUnit.xml

Known Issues

The type generation in the markdown output may occasionally be incorrect. This is often due to malformed XML produced by Delphi, especially when dealing with generic types.