ApiTypeDetail Pennington.ApiMetadata

Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).

Properties

Implements System.Collections.Immutable.ImmutableArray<string>: Implemented-interface uids.
Inheritance System.Collections.Immutable.ImmutableArray<string>: Base-type uids, most-derived first. Empty for interfaces and object.
SignatureHtml string?: Default: null
Pre-highlighted declaration HTML, or null when not available.
Source Pennington.ApiMetadata.ApiSourceLocation?: Default: null
Optional source-link target for a "view source" button.
Summary Pennington.ApiMetadata.ApiTypeSummary: Header describing the type.
Xmldoc Pennington.ApiMetadata.ParsedXmlDoc: Parsed xmldoc for the type itself.

Constructors

.ctor

public sealed record ApiTypeDetail(
    ApiTypeSummary Summary,
    ParsedXmlDoc Xmldoc,
    string? SignatureHtml,
    ImmutableArray<string> Inheritance,
    ImmutableArray<string> Implements,
    ApiSourceLocation? Source);

Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).

Parameters

Summary ApiTypeSummary: Header describing the type.
Xmldoc ParsedXmlDoc: Parsed xmldoc for the type itself.
SignatureHtml string?: Pre-highlighted declaration HTML, or null when not available.
Inheritance ImmutableArray<string>: Base-type uids, most-derived first. Empty for interfaces and object.
Implements ImmutableArray<string>: Implemented-interface uids.
Source ApiSourceLocation?: Optional source-link target for a "view source" button.

Pennington.ApiMetadata.ApiTypeDetail

namespace Pennington.ApiMetadata;

/// Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
public record ApiTypeDetail
{
    /// Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
    public sealed record ApiTypeDetail(
    ApiTypeSummary Summary,
    ParsedXmlDoc Xmldoc,
    string? SignatureHtml,
    ImmutableArray<string> Inheritance,
    ImmutableArray<string> Implements,
    ApiSourceLocation? Source);

    /// Implemented-interface uids.
    ImmutableArray<string> Implements;

    /// Base-type uids, most-derived first. Empty for interfaces and object.
    ImmutableArray<string> Inheritance;

    /// Pre-highlighted declaration HTML, or null when not available.
    string? SignatureHtml;

    /// Optional source-link target for a "view source" button.
    ApiSourceLocation? Source;

    /// Header describing the type.
    ApiTypeSummary Summary;

    /// Parsed xmldoc for the type itself.
    ParsedXmlDoc Xmldoc;
}