public class DocGenerator

assembly RefDocGen
namespace RefDocGen
Base type:  object
Class responsible for generating the reference documentation using the provided DLL and XML doc comments file.

Constructors

public DocGenerator(IEnumerable<string> assemblyPaths, ITemplateProcessor templateProcessor, AssemblyDataConfiguration assemblyDataConfiguration, string outputDirectory, string projectName, Microsoft.Extensions.Logging.ILogger logger) #
Initialize a new instance of DocGenerator class.
Parameters
IEnumerable<string> assemblyPaths
Paths to the DLL assemblies.
ITemplateProcessor templateProcessor
An instance used for processing the templates.
AssemblyDataConfiguration assemblyDataConfiguration
Configuration describing what data should be extracted from the assemblies.
string outputDirectory
The directory, where the generated output will be stored.
string projectName
Name of the assembly/project/solution to be documented (without file extension).
Microsoft.Extensions.Logging.ILogger logger
A logger instance.

Methods

public void GenerateDoc() #
Generates the reference documentation using the provided DLL and XML comments file.