GeneratorsRegistrations
public sealed class GeneratorsRegistrationsNamespace: RhoMicro.BindSight.Generators
Inheritance:
DirectoryGeneratorsRegistrations
Summary
Section titled “Summary”Wraps an BindSightBuilder for registering options docs generators.
Constructors
Section titled “Constructors”GeneratorsRegistrations(BindSightBuilder)
Section titled “GeneratorsRegistrations(BindSightBuilder)”public GeneratorsRegistrations(BindSightBuilder optionsDocs)Summary
Section titled “Summary”Wraps an BindSightBuilder for registering options docs generators.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
optionsDocs | BindSightBuilder | The BindSightBuilder to wrap. |
Properties
Section titled “Properties”BindSight
Section titled “BindSight”public BindSightBuilder BindSight { get; }Summary
Section titled “Summary”Gets the wrapped BindSightBuilder.
Methods
Section titled “Methods”AddGenerator<TGenerator>()
Section titled “AddGenerator<TGenerator>()”public GeneratorsRegistrations AddGenerator<TGenerator>() where TGenerator : class, IBindSightGeneratorSummary
Section titled “Summary”Adds a generator to generate docs with.
Type Parameters
Section titled “Type Parameters”| Name | Description | Constraints |
|---|---|---|
TGenerator | The type of generator to register. | class, IBindSightGenerator |
Returns
Section titled “Returns”A reference to this object, for chaining of further method calls.
AddLogging()
Section titled “AddLogging()”public GeneratorsRegistrations AddLogging()Summary
Section titled “Summary”Adds the LoggingBindSightGenerator for logging all detected options.
Returns
Section titled “Returns”A reference to this object, for chaining of further method calls.
AddJsonSchemata(Action<JsonSchemaGeneratorOptionsConfiguration>)
Section titled “AddJsonSchemata(Action<JsonSchemaGeneratorOptionsConfiguration>)”public GeneratorsRegistrations AddJsonSchemata([Action<JsonSchemaGeneratorOptionsConfiguration>? configure = null])Summary
Section titled “Summary”Adds the JsonSchemaGenerator for generating json schemata of options.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
configure | Action<JsonSchemaGeneratorOptionsConfiguration> | ServiceCollectionExtensions.TryAddJsonSchemaGeneratorOptions |
Returns
Section titled “Returns”A reference to this object, for chaining of further method calls.
AddReadme(Action<ReadmeGeneratorOptionsConfiguration>)
Section titled “AddReadme(Action<ReadmeGeneratorOptionsConfiguration>)”public GeneratorsRegistrations AddReadme([Action<ReadmeGeneratorOptionsConfiguration>? configure = null])Summary
Section titled “Summary”Adds the ReadmeGenerator for generating a readme of options.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
configure | Action<ReadmeGeneratorOptionsConfiguration> | ServiceCollectionExtensions.TryAddReadmeGeneratorOptions |
Returns
Section titled “Returns”A reference to this object, for chaining of further method calls.
AddDefaults()
Section titled “AddDefaults()”public GeneratorsRegistrations AddDefaults()Summary
Section titled “Summary”Adds default generators.
Remarks
Section titled “Remarks”The generators added are:
Returns
Section titled “Returns”A reference to this object, for chaining of further method calls.