> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DocMember

> Represents documentation for a .NET member (method, property, field, event, etc.).

## Definition

**Assembly:** CloudNimble.DotNetDocs.Core.dll

**Namespace:** CloudNimble.DotNetDocs.Core

**Inheritance:** CloudNimble.DotNetDocs.Core.DocEntity

## Syntax

```csharp theme={"dark"}
CloudNimble.DotNetDocs.Core.DocMember
```

## Summary

Represents documentation for a .NET member (method, property, field, event, etc.).

## Remarks

Contains metadata about a type member, extracted from Roslyn symbols and enhanced
with conceptual documentation.

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

Initializes a new instance of the [DocMember](/api-reference/CloudNimble/DotNetDocs/Core/DocMember) class.

#### Syntax

```csharp theme={"dark"}
public DocMember(Microsoft.CodeAnalysis.ISymbol symbol)
```

#### Parameters

| Name     | Type                             | Description               |
| -------- | -------------------------------- | ------------------------- |
| `symbol` | `Microsoft.CodeAnalysis.ISymbol` | The Roslyn member symbol. |

#### Exceptions

| Exception               | Description                   |
| ----------------------- | ----------------------------- |
| `ArgumentNullException` | Thrown when *symbol* is null. |

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class.

#### Syntax

```csharp theme={"dark"}
protected DocEntity()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Initializes a new instance of the [DocEntity](/api-reference/CloudNimble/DotNetDocs/Core/DocEntity) class with an ISymbol.

#### Syntax

```csharp theme={"dark"}
protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol)
```

#### Parameters

| Name     | Type                              | Description                                    |
| -------- | --------------------------------- | ---------------------------------------------- |
| `symbol` | `Microsoft.CodeAnalysis.ISymbol?` | The symbol to store as the original reference. |

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Accessibility

Gets or sets the accessibility level of the member.

#### Syntax

```csharp theme={"dark"}
public Microsoft.CodeAnalysis.Accessibility Accessibility { get; set; }
```

#### Property Value

Type: `Microsoft.CodeAnalysis.Accessibility?`
The accessibility level (public, private, protected, etc.).

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> BestPractices <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the best practices documentation content.

#### Syntax

```csharp theme={"dark"}
public string BestPractices { get; set; }
```

#### Property Value

Type: `string?`
Markdown content with best practices, recommendations, and guidelines from conceptual documentation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Considerations <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the considerations or notes related to the current context.

#### Syntax

```csharp theme={"dark"}
public string Considerations { get; set; }
```

#### Property Value

Type: `string?`
Markdown content with gotchas, performance, or security notes from conceptual documentation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> DeclaringTypeName

Gets or sets the fully qualified name of the type that declares this member.

#### Syntax

```csharp theme={"dark"}
public string DeclaringTypeName { get; set; }
```

#### Property Value

Type: `string?`
For inherited members, this is the base type or interface name.
For extension methods, this is the static class containing the method.
For declared members, this matches the containing type.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> DisplayName <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the display name of the entity.

#### Syntax

```csharp theme={"dark"}
public string DisplayName { get; set; }
```

#### Property Value

Type: `string?`
The fully qualified display name extracted from the Symbol.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Examples <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the examples documentation content.

#### Syntax

```csharp theme={"dark"}
public string Examples { get; set; }
```

#### Property Value

Type: `string?`
Markdown content containing code examples from XML \<example> tags.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Exceptions <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the collection of exceptions that can be thrown.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocException> Exceptions { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocException>?`
Collection of exception documentation from XML \<exception> tags.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ExtendedTypeName

Gets or sets the fully qualified name of the type this extension method extends.

#### Syntax

```csharp theme={"dark"}
public string ExtendedTypeName { get; set; }
```

#### Property Value

Type: `string?`
The type of the first parameter (with `this` modifier), or `null` if not an extension method.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IncludedMembers <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the list of member accessibilities to include (default: Public).

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility> IncludedMembers { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility>`
List of accessibility levels to include when processing child members.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsAbstract

Gets or sets whether this member is abstract.

#### Syntax

```csharp theme={"dark"}
public bool IsAbstract { get; set; }
```

#### Property Value

Type: `bool`
`true` if the member uses the `abstract` keyword; otherwise `false`.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsExtensionMethod

Gets or sets whether this member is an extension method.

#### Syntax

```csharp theme={"dark"}
public bool IsExtensionMethod { get; set; }
```

#### Property Value

Type: `bool`
`true` if this is a static method with the `this` modifier on its first parameter;
otherwise `false`.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsInherited

Gets or sets whether this member is inherited from a base type or interface.

#### Syntax

```csharp theme={"dark"}
public bool IsInherited { get; set; }
```

#### Property Value

Type: `bool`
`true` if the member is declared in a base type or interface;
`false` if declared in the containing type.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsOverride

Gets or sets whether this member overrides a base implementation.

#### Syntax

```csharp theme={"dark"}
public bool IsOverride { get; set; }
```

#### Property Value

Type: `bool`
`true` if the member uses the `override` keyword; otherwise `false`.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsVirtual

Gets or sets whether this member is virtual.

#### Syntax

```csharp theme={"dark"}
public bool IsVirtual { get; set; }
```

#### Property Value

Type: `bool`
`true` if the member uses the `virtual` keyword; otherwise `false`.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberKind

Gets or sets the member kind (method, property, field, event, etc.).

#### Syntax

```csharp theme={"dark"}
public Microsoft.CodeAnalysis.SymbolKind MemberKind { get; set; }
```

#### Property Value

Type: `Microsoft.CodeAnalysis.SymbolKind?`
The kind of member as defined by Roslyn.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MethodKind

Gets or sets the method kind for method members.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<Microsoft.CodeAnalysis.MethodKind> MethodKind { get; set; }
```

#### Property Value

Type: `System.Nullable<Microsoft.CodeAnalysis.MethodKind?>?`
The kind of method (Constructor, Ordinary, etc.), or null for non-method members.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Name

Gets or sets the name of the member.

#### Syntax

```csharp theme={"dark"}
public string Name { get; set; }
```

#### Property Value

Type: `string`
The member name.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OriginalSymbol <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets the original symbol this documentation entity was created from.

#### Syntax

```csharp theme={"dark"}
public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; }
```

#### Property Value

Type: `Microsoft.CodeAnalysis.ISymbol?`
The Roslyn ISymbol that was used to create this entity, preserved for reference.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OverriddenMember

Gets or sets the signature of the member being overridden, if applicable.

#### Syntax

```csharp theme={"dark"}
public string OverriddenMember { get; set; }
```

#### Property Value

Type: `string?`
The fully qualified signature of the base member, or `null` if not an override.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Parameters

Gets the collection of parameters for this member.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocParameter> Parameters { get; init; }
```

#### Property Value

Type: `System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocParameter>`
List of documented parameters. Empty for members without parameters.

#### Remarks

This collection is populated for methods, constructors, delegates, and indexers.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Patterns <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the patterns documentation content.

#### Syntax

```csharp theme={"dark"}
public string Patterns { get; set; }
```

#### Property Value

Type: `string?`
Markdown content explaining common usage patterns and architectural guidance from conceptual documentation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> RelatedApis <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets a list of related API names.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.ICollection<string> RelatedApis { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.ICollection<string>?`
List of fully qualified names or URLs for related APIs from conceptual documentation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Remarks <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the remarks from XML documentation.

#### Syntax

```csharp theme={"dark"}
public string Remarks { get; set; }
```

#### Property Value

Type: `string?`
Content from the XML documentation's \<remarks> element.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Returns <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the return value documentation.

#### Syntax

```csharp theme={"dark"}
public string Returns { get; set; }
```

#### Property Value

Type: `string?`
Description of the return value from XML \<returns> tag.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReturnType

Gets the return type documentation, if applicable.

#### Syntax

```csharp theme={"dark"}
public CloudNimble.DotNetDocs.Core.DocType ReturnType { get; set; }
```

#### Property Value

Type: `CloudNimble.DotNetDocs.Core.DocType?`
Documentation for the return type, or null for void methods and non-method members.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReturnTypeName

Gets or sets the name of the return type.

#### Syntax

```csharp theme={"dark"}
public string ReturnTypeName { get; set; }
```

#### Property Value

Type: `string?`
The return type name for methods and properties, or null for other members.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SeeAlso <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the collection of see-also references.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference> SeeAlso { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference>?`
Collection of related items from XML \<seealso> tags.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Signature

Gets or sets the signature of the member.

#### Syntax

```csharp theme={"dark"}
public string Signature { get; set; }
```

#### Property Value

Type: `string?`
The member signature including modifiers, return type, parameters, etc.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Summary <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the summary from XML documentation.

#### Syntax

```csharp theme={"dark"}
public string Summary { get; set; }
```

#### Property Value

Type: `string?`
Brief description of what the API element IS, from XML \<summary> tag.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Symbol

Gets the Roslyn symbol for the member.

#### Syntax

```csharp theme={"dark"}
public Microsoft.CodeAnalysis.ISymbol Symbol { get; }
```

#### Property Value

Type: `Microsoft.CodeAnalysis.ISymbol`
The underlying Roslyn symbol containing metadata.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> TypeParameters <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the collection of type parameters.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocTypeParameter> TypeParameters { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocTypeParameter>?`
Collection of type parameter documentation from XML \<typeparam> tags.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Usage <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the usage documentation content.

#### Syntax

```csharp theme={"dark"}
public string Usage { get; set; }
```

#### Property Value

Type: `string?`
Markdown content explaining HOW to use the API element, from conceptual documentation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Value <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Gets or sets the value description for properties.

#### Syntax

```csharp theme={"dark"}
public string Value { get; set; }
```

#### Property Value

Type: `string?`
Description of what the property represents from XML \<value> tag.

## Methods

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToJson <Badge color="gray">Inherited</Badge>

<Note>Inherited from `CloudNimble.DotNetDocs.Core.DocEntity`</Note>

Serializes this entity to JSON using consistent options.

#### Syntax

```csharp theme={"dark"}
public string ToJson()
```

#### Returns

Type: `string`
The JSON string representation of this entity.

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`