Skip to main content

Definition

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

Syntax

Summary

Manages assembly metadata extraction using Roslyn for API documentation generation.

Remarks

Extracts metadata from a single .NET assembly and its XML documentation file, building an in-memory model (DocAssembly) with interconnected types, members, and parameters. Supports conceptual content loading from a specified folder. Designed for multi-targeting .NET 10.0, 9.0, and 8.0. One instance per assembly is required, with paths specified at construction for incremental build support. Implements IDisposable to release memory used by the compilation and model.

Examples

Constructors

.ctor

Initializes a new instance of AssemblyManager for a specific assembly.

Syntax

Parameters

Exceptions

Remarks

If the XML documentation file does not exist, processing will continue without XML documentation. A warning will be added to the Errors collection.

.ctor Inherited

Inherited from object

Syntax

Properties

AssemblyName

Gets the name of the assembly (without extension).

Syntax

Property Value

Type: string

AssemblyPath

Gets the path to the assembly DLL file.

Syntax

Property Value

Type: string

Document

Gets the current documentation model for the processed assembly.

Syntax

Property Value

Type: CloudNimble.DotNetDocs.Core.DocAssembly?

Errors

Gets the collection of errors that occurred during Since processing.

Syntax

Property Value

Type: System.Collections.Generic.List<System.CodeDom.Compiler.CompilerError>

Remarks

Includes warnings about inaccessible internal members when requested but not available.

LastModified

Gets the last modified timestamp of the assembly file for incremental builds.

Syntax

Property Value

Type: System.DateTime

XmlPath

Gets the path to the XML documentation file.

Syntax

Property Value

Type: string?

Remarks

May be null if no XML documentation file is available.

Methods

Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Syntax

DocumentAsync

Documents the assembly asynchronously, building or rebuilding an in-memory model with metadata and documentation if necessary.

Syntax

Parameters

Returns

Type: System.Threading.Tasks.Task<CloudNimble.DotNetDocs.Core.DocAssembly> A task representing the asynchronous operation, containing the DocAssembly model.

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?
  • System.IDisposable