ReadmeGenerator
public sealed class ReadmeGeneratorNamespace: RhoMicro.BindSight.Generators
Inheritance:
Summary
Section titled “Summary”Generates a readme file outlining the available options.
Constructors
Section titled “Constructors”ReadmeGenerator(IReadmeGeneratorOptions, ILogger<ReadmeGenerator>)
Section titled “ReadmeGenerator(IReadmeGeneratorOptions, ILogger<ReadmeGenerator>)”public ReadmeGenerator(IReadmeGeneratorOptions readmeOptions, ILogger<ReadmeGenerator> logger)Summary
Section titled “Summary”Generates a readme file outlining the available options.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
logger | ILogger<ReadmeGenerator> | The logger to use. |
readmeOptions | IReadmeGeneratorOptions | The options to use. |
Methods
Section titled “Methods”Run(IBindSightGeneratorOptions, CancellationToken)
Section titled “Run(IBindSightGeneratorOptions, CancellationToken)”public ValueTask Run(IBindSightGeneratorOptions optionsDocsGeneratorOptions, [CancellationToken cancellationToken = default(CancellationToken)])Summary
Section titled “Summary”Runs the generator.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
cancellationToken | CancellationToken | The cancellation token used to request generating to be cancelled. |
optionsDocsGeneratorOptions | IBindSightGeneratorOptions | The options to use. |
Returns
Section titled “Returns”A task representing the generating of documentation.