Skip to main content

​
Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: System.Object

​
Syntax

CloudNimble.DotNetDocs.Core.DocumentationManager

​
Summary

Orchestrates the documentation pipeline for one or more assemblies.

​
Remarks

This class manages the complete documentation lifecycle including enrichment, transformation, and rendering. It handles AssemblyManager creation, usage, and disposal for processing assemblies.

​
Constructors

​
.ctor

Initializes a new instance of the DocumentationManager class.

​
Syntax

public DocumentationManager(CloudNimble.DotNetDocs.Core.ProjectContext projectContext, System.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocEnricher> enrichers = null, System.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocTransformer> transformers = null, System.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocRenderer> renderers = null, System.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocReferenceHandler> referenceHandlers = null)

​
Parameters

NameTypeDescription
projectContextCloudNimble.DotNetDocs.Core.ProjectContextThe project context containing configuration settings.
enrichersSystem.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocEnricher>?The enrichers to apply to documentation entities.
transformersSystem.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocTransformer>?The transformers to apply to the documentation model.
renderersSystem.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocRenderer>?The renderers to generate output formats.
referenceHandlersSystem.Collections.Generic.IEnumerable<CloudNimble.DotNetDocs.Core.IDocReferenceHandler>?The handlers for processing documentation references.

​
Remarks

This constructor is designed to work with dependency injection containers. All parameters accept IEnumerable collections that are typically injected by the DI container.

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Methods

​
CreateConceptualFilesAsync

Creates placeholder conceptual documentation files for a single assembly.

​
Syntax

public System.Threading.Tasks.Task CreateConceptualFilesAsync(string assemblyPath, string xmlPath)

​
Parameters

NameTypeDescription
assemblyPathstringThe path to the assembly file.
xmlPathstringThe path to the XML documentation file.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous operation.

​
CreateConceptualFilesAsync

Creates placeholder conceptual documentation files for multiple assemblies.

​
Syntax

public System.Threading.Tasks.Task CreateConceptualFilesAsync(System.Collections.Generic.IEnumerable<(string, string)> assemblies)

​
Parameters

NameTypeDescription
assembliesSystem.Collections.Generic.IEnumerable<(string, string)>The collection of assembly and XML path pairs.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous operation.

​
Dispose

Disposes of all cached AssemblyManager instances.

​
Syntax

public void Dispose()

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ProcessAsync

Processes a single assembly through the documentation pipeline.

​
Syntax

public System.Threading.Tasks.Task ProcessAsync(string assemblyPath, string xmlPath)

​
Parameters

NameTypeDescription
assemblyPathstringThe path to the assembly file.
xmlPathstringThe path to the XML documentation file.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous processing operation.

​
ProcessAsync

Processes multiple assemblies through the documentation pipeline.

​
Syntax

public System.Threading.Tasks.Task ProcessAsync(System.Collections.Generic.IEnumerable<(string, string)> assemblies)

​
Parameters

NameTypeDescription
assembliesSystem.Collections.Generic.IEnumerable<(string, string)>The collection of assembly and XML path pairs.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous processing operation.

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?
  • System.IDisposable