Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocEntitySyntax
Summary
Represents documentation for a .NET assembly.Remarks
Contains metadata about an assembly and its namespaces, extracted from Roslyn symbols and enhanced with conceptual documentation.Constructors
.ctor
Initializes a new instance of the DocAssembly class.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.IAssemblySymbol | The Roslyn assembly symbol. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
Properties
AssemblyName
Gets or sets the name of the assembly.Syntax
Property Value
Type:string
The assembly name.
Namespaces
Gets the collection of namespaces in the assembly.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocNamespace>
List of documented namespaces within this assembly.
Symbol
Gets the Roslyn symbol for the assembly.Syntax
Property Value
Type:Microsoft.CodeAnalysis.IAssemblySymbol
The underlying Roslyn assembly symbol containing metadata.
Version
Gets or sets the version of the assembly.Syntax
Property Value
Type:string?
The assembly version string.