Class DocumentationGenerator
Inheritance
System.Object
DocumentationGenerator
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NetDocsForLLM.Services
Assembly: NetDocsForLLM.dll
Syntax
public class DocumentationGenerator : IDocumentationGeneratorConstructors
DocumentationGenerator(IDocFxService)
Declaration
public DocumentationGenerator(IDocFxService docFxService)Parameters
| Type | Name | Description |
|---|---|---|
| IDocFxService | docFxService |
Methods
GenerateDocumentation(IEnumerable<AssemblyModel>, ExportSettings)
Declaration
public async Task<DocumentationModel> GenerateDocumentation(IEnumerable<AssemblyModel> assemblies, ExportSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<AssemblyModel> | assemblies | |
| ExportSettings | settings |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DocumentationModel> |
GenerateDocumentationPreview(DocumentationModel, ExportSettings)
Declaration
public string GenerateDocumentationPreview(DocumentationModel documentation, ExportSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentationModel | documentation | |
| ExportSettings | settings |
Returns
| Type | Description |
|---|---|
| System.String |