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