Summary.DocMember.md

Summary.DocMember

public abstract record DocMember

A member of the generated document (e.g. type, field, property, method, etc.).

Properties

Namespace

public required string Namespace { get; init; }

The namespace the member is defined in.

FullyQualifiedName

public required string FullyQualifiedName { get; init; }

The fully qualified name of the member (e.g., Summary.DocMember).

Name

public required string Name { get; init; }

The name of the member (e.g. public int Field has name Field).

Declaration

public required string Declaration { get; init; }

The code-snippet that contains the full declaration of the member (e.g. public int Field is a declaration of the field member Field).

Access

public required AccessModifier Access { get; init; }

The access modifier of the member.

DeclaringType

public required DocType? DeclaringType { get; init; }

The type that this member is declared in (works for nested types as well).

Comment

public DocComment Comment { get; set; }

The documentation comment of the member (can be empty).

Deprecated

[MemberNotNullWhen(true, nameof(Deprecation))]
public bool Deprecated { get; }

Whether the member is deprecated (e.g. marked with [Obsolete]).

Deprecation

public DocDeprecation? Deprecation { get; init; }

The member deprecation information.

Location

public DocLocation? Location { get; init; }

The location of the member.

Usings

public required string[] Usings { get; init; }

The list of using statements imported in the scope of this type declaration.