Overview
The XML Documenter is the simplest of the NDoc3 Documenters. It is primarily a development tool.
As part of the documentation compile process, NDoc3 merges the type information in the assemblies being documented with the code comment summary XML document that the /doc compiler option emits. The XML Documenter allows you to save this merged set of data for curiosity's sake or debugging purposes.
Used in conjunction with the UseNDocXmlFile setting, this is especially useful when you are working on your own documenters.
IMPORTANT: The XML produced by this documenter is an internal implementation detail and as such is not guaranteed to remain constant, or even remain back-backward compatible between released versions.
Settings
All documenters share a common set of documenter settings.
| Setting | Description |
|---|---|
| OutputFile | This is the path and filename of the file where the merged documentation will be written. This can be absolute or relative from the .ndoc project file. |