Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocEntitySyntax
Summary
Represents documentation for a .NET type.Remarks
Contains metadata about a type (class, interface, struct, enum, delegate) and its members, extracted from Roslyn symbols and enhanced with conceptual documentation.Constructors
.ctor
Initializes a new instance of the DocType class.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.ITypeSymbol | The Roslyn type symbol. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
Properties
AssemblyName
Gets or sets the containing assembly name.Syntax
Property Value
Type:string?
The name of the assembly containing this type.
BaseType
Gets the base type name, if any.Syntax
Property Value
Type:string?
The name of the base type, or null if none exists.
FullName
Gets or sets the fully qualified name of the type.Syntax
Property Value
Type:string?
The fully qualified type name including namespace.
Members
Gets the collection of members (methods, properties, fields, events, etc.).Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocMember>
List of documented members within this type.
Name
Gets or sets the name of the type.Syntax
Property Value
Type:string
The type name.
Signature
Gets or sets the signature of the type.Syntax
Property Value
Type:string?
The type signature including modifiers, inheritance, etc.
Symbol
Gets the Roslyn symbol for the type.Syntax
Property Value
Type:Microsoft.CodeAnalysis.ITypeSymbol
The underlying Roslyn type symbol containing metadata.
TypeKind
Gets or sets the type kind.Syntax
Property Value
Type:Microsoft.CodeAnalysis.TypeKind?
The kind of type (Class, Interface, Struct, Enum, Delegate, etc.).