XmlDocProvider.ImportFile Method
- Namespace
- Kampute.DocToolkit.XmlDoc
- Assembly
- Kampute.DocToolkit.dll
Definition
Imports XML documentation from the specified documentation file, resolving any include directives.
public virtual void ImportFile(string xmlDocPath)Parameters
xmlDocPathstring- The absolute or relative path to the XML documentation file.
Exceptions
- ArgumentException
- Thrown when
xmlDocPathis null or empty. - FileNotFoundException
- Thrown when the XML documentation file does not exist.
- Thrown when an included file does not exist and no error handler is provided.
Remarks
This method first resolves any include directives in the XML document using the file's directory as the base path, then imports the member documentation. If the XML document contains members that already exist in the provider, the new documentation replaces the existing documentation.